terraink README

The project's README from github.com/yousifamanuel/terraink. As one markdown file: README.md.

Terraink

Website Badge Email Badge LinkedIn Badge Instagram YouTube Threads Reddit TikTok Product Hunt

Bun Badge Vite Badge React Badge JavaScript Badge TypeScript Badge OpenStreetMap Badge MapLibre Badge GitHub Badge Cloudflare Badge Docker Badge

Note: Terraink is still in development. Every feedback is appreciated. This is an open-source project, and community contributions are very welcome.

License & Trademark Notice: This project is licensed under AGPL-3.0 and includes trademark protections. See the License and Trademark sections for details.

Features

Data Providers and Mapping Stack

User Interface

Terraink web UI

Showcase

Featured showcase example 1 Featured showcase example 2

License

As of April 3rd 2026, all new changes to this repository are licensed under AGPL-3.0. Code released before that date remains under the MIT License.

The hosted Terraink service includes attribution and branding as part of the user interface.

If you deploy or modify the open-source version, you are responsible for complying with the AGPL-3.0 license, including preserving license and copyright notices.

For access to the hosted version with additional features and support, see Terraink Business or contact: [email protected].

Trademark

Terraink™ is a trademark of Yousuf Amanuel. An application for registration has been filed with the German Patent and Trade Mark Office (DPMA). This filing establishes priority rights under the Paris Convention, allowing international trademark registration to be pursued within six months of the original filing date. The Terraink logo, visual identity, and branding assets are copyright © 2026 Yousuf Amanuel. All rights reserved.

Unauthorized use of the Terraink name in connection with similar software, map services, or related commercial products may be restricted. For licensing inquiries, contact [email protected].

See TRADEMARK.md for details.

Run

bun install
bun run dev

Environment

Check .env.example for available variables. They are optional for most local work and should not be set during testing unless a specific case requires them.

Build

bun run build

Deploy with Docker (Self-Hosting)

1) Build and run with Docker Compose

Create .env from .env.example (or set APP_PORT directly in your shell), then run:

docker compose up -d --build

This serves the app on http://localhost:7200 by default.

To change the exposed host port:

APP_PORT=80 docker compose up -d --build
$env:APP_PORT=80
docker compose up -d --build

2) Stop the deployment

docker compose down

3) Optional: build and run without Compose

docker build -t terraink:latest .
docker run -d --name terraink -p 7200:80 --restart unless-stopped terraink:latest

Contributing

The contribution guidelines are meant to keep Terraink easy to extend, review, and maintain over time. They are here to support a durable architecture, not to add unnecessary friction.

Read CONTRIBUTING.md before opening a PR.

Attribution

Acknowledgment

Terraink was inspired by MapToPoster by Ankur Gupta, originally released under the MIT license. Terraink is an independent reimplementation built from scratch using Bun, React, and TypeScript, and has since evolved significantly beyond the original concept.

Star History

Star History Chart

terraink (yousifamanuel/terraink)

Searching Database…

What is this?Terraink is a cartographic poster engine that generates unique, customizable map posters for any city or location in the world using real OpenStreetMap data.
Is this a desktop app or a web app I host myself?It is a self-hosted web app built with Bun, React, and TypeScript that you deploy and open in a browser to design posters.
How do I get it running?Copy .env.example to .env, then build and run it with Docker Compose, which serves the app on an exposed port by default (changeable via APPPORT).
What do I need before deploying it?Docker and Docker Compose for self-hosting, or Bun if you want to build and run it manually with 'bunx --bun vite'; environment variables are optional for local use.
Any catch with the license if I self-host it?As of April 2026 all new code is under AGPL-3.0 with trademark protections on the Terraink name, so if you deploy or modify it you must comply with AGPL-3.0, including preserving license and copyright notices.
What customization options does it offer for a poster?You can pick from dozens of curated themes or build custom color palettes, control which map layers (roads, water, parks, building footprints) are shown and styled, and set city/country labels in one of nine bundled typefaces.
What formats can I export a poster in?High-resolution posters can be exported as PNG, PDF, or layered SVG at any defined dimension, ready for printing.
What powers the map rendering and search?Map data comes from OpenStreetMap via OpenMapTiles tiles hosted on OpenFreeMap, rendered with MapLibre GL JS, with geocoding handled by Nominatim.
Why was Terraink built?It was inspired by the MIT-licensed MapToPoster project by Ankur Gupta but is an independent reimplementation from scratch using Bun, React, and TypeScript that has since evolved well beyond the original concept.
Size
36.8 MB
Stars
4.2K
Age
8mo
Commits · 90 Days