Skip to content

bertrandmd/editor

 
 

Repository files navigation

Maputnik Build Status License

A free and open visual editor for the Mapbox GL styles targeted at developers and map designers. Creating your own custom map is easy with Maputnik.

Please support this project on Kickstarter.

Support this project and watch the Kickstarter campaign video

Reasons for building a Mapbox GL Style Editor

Mapbox GL is one of the biggest innovations the GIS world and is the first cross platform framework to display maps on the browser, mobile applications and the desktop. Maps are styled using a JSON style document with properties described in the Mapbox GL style specification. The style specification is adopted in more and more clients such as Open Layers 3 and therefore the missing piece in the puzzle is a style editor that is easy to use, free and open source!

In constrast to earlier approaches using CartoCSS the format is difficult to edit by hand but much more suitable for generating from an editor. As of today Mapbox GL styles are usually designed within the cloud based Mapbox Studio which is a great example how a style editor should look like.

The big problem is that Mapbox Studio is not open source and you have to upload your data sources to external servers and essentially are locked in the Mapbox ecosystem. By reusing existing proprietary base styles you legally tie your style for use with Mapbox services. It is difficult to use other data source like OSM2VectorTiles, Mapzen or Kartotherian or even your own custom vector tile sources.

This is why I think we should rally behind and build our own style editor for the Mapbox GL style specification! Help me get the funding together to take time of work and make this happen!

Features

  • Completely free and open source
  • Visual interface for designing maps
  • Immediate feedback (thanks to style diffs)
  • Edit layers
  • No vendor lock-in, no proprietary base styles
  • Easy to deploy as single HTML file

Demo showing interactive feedback

Roadmap

  • Layer editing history (it is a mess right now)
  • Add new layers
  • Support all layer types
  • Choose sources
  • Filter data from sources
  • Support zoom level specific values
  • Faster map feedback with custom diff algorithm
  • Tests for React components
  • Make it prettier

Develop

Maputnik is written in ES6 and is using React, Immutable.js and Mapbox GL JS.

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

# install dependencies
npm install
# start dev server
npm start

Build a production package for distribution.

npm run build

Lint the JavaScript code.

# install lint dependencies
npm install --save-dev eslint eslint-plugin-react
# run linter
npm run lint

License

Maputnik is licensed under MIT and is Copyright (c) Lukas Martinelli and contributors.

Disclaimer This project is not affiliated with Mapbox or Mapbox Studio. It is a free independent style editor for the open source technology in the Mapbox GL ecosystem. As contributor please take extra care of not violating any Mapbox trademarks. Do not get inspired by Mapbox Studio and make your own decisions for a good style editor in order to avoid future copyright problems like in OSM2VectorTiles.

About

Visual Map Editor for Mapbox GL

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.7%
  • Other 1.3%