Repository files navigation

A free and open visual editor for theMapLibre GL stylestargeted at developers and map designers.

• 🔗 Design your maps online athttps://www.maplibre.org/maputnik/ (all in local storage)
• 🔗 Use theMaputnik CLI for local style development
• In a Docker, run this command and browse tohttp://localhost:8888, Ctrl+C to stop the server.

docker run -it --rm -p 8888:80 ghcr.io/maplibre/maputnik:main

The documentation can be found in theWiki. You are welcome to collaborate!

• 🔗Study theMaputnik Wiki
• 📹 Design a map from Scratchhttps://youtu.be/XoDh0gEnBQo

Maputnik is written in typescript and is usingReact andMapLibre GL JS.

We ensure building and developing Maputnik works with thecurrent active LTS Node.js version and above.

Check out ourInternationalization guide for UI text related changes.

Join the #maplibre or #maputnik slack channel at OSMUS: get an invite athttps://slack.openstreetmap.us/ Read the the below guide in order to get familiar with how we do things around here.

Install the deps, start the dev server and open the web browser onhttp://localhost:8888/.

# install dependenciesnpm install# start dev servernpm run start

If you want Maputnik to be accessible externally use the--host option:

# start externally accessible dev servernpm run start -- --host 0.0.0.0

The build process will watch for changes to the filesystem, rebuild and autoreload the editor.

npm run build

Lint the JavaScript code.

# run linternpm run lintnpm run lint-cssnpm run sort-styles

For E2E testing we useCypress

Cypress doesn't starts a server so you'll need to start one manually by runningnpm run start.

Now open a terminal and run the following usingchrome:

npm run test

orfirefox:

npm run test -- --browser firefox

See the following docs for more info: (Launching Browsers)[https://docs.cypress.io/guides/guides/launching-browsers]

You can also see the tests as they run or select which suites to run by executing:

npm run cy:open

1. ReviewCHANGELOG.md
   • Double-check that all changes included in the release are appropriately documented.
   • To-be-released changes should be under the "main" header.
   • Commit any final changes to the changelog.
2. RunCreate bump version PR by manual workflow dispatch and set the version number in the input. This will create a PR that changes the changelog andpackage.json file to review and merge.
3. Once merged, an automatic process will kick in and creates a GitHub release and uploads release assets.

Thanks to the supporters of theKickstarter campaign. This project would not be possible without these commercial and individual sponsors.You can see this file's history for previous sponsors of the original Maputnik repo.Read more about the MapLibre Sponsorship Program athttps://maplibre.org/sponsors/.

Maputnik islicensed under MIT and is Copyright (c) Lukas Martinelli and Maplibre contributors.As contributor please take extra care of not violating any Mapbox trademarks. Do not get inspired by other map studios and make your own decisions for a good style editor.