Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A modern map design studio.
JavaScript HTML Objective-C CSS CartoCSS C Other
Failed to load latest commit information.
_posts/docs/reference Eliminate syncAPI option.
assets Merge pull request #2184 from versusvoid/master
commands Merge pull request #2465 from mapbox/upload
controllers Non-blocking update checking on client startup
data/82945364-10m-admin-0-countries Selectively copy sample data file to MapBox/cache dir. Refs #1114.
examples update ancient example comments, fixes #1964
fonts bundle dejavu fonts for back compat - closes #2272
lib Eliminate syncAPI option.
models use mapnik version rather than node-mapnik version
platforms stash updates to windows build
plugins Adjustings
servers bundle showdown since node-markdown is deprecated
templates copyright/naming/date updates
test drop contexify dep
views fix format dropdown/custom input behavior - accidentally switched in 9…
.gitignore DIRTY
.travis.yml appveyor + travis updates
LICENSE.md update copyright to MapBox
README.md Updating clone instructions to a readable URL
appveyor.yml Start running tests on appveyor - refs #2469
configure.js add protobuf/pkg-config to configure script
index.js bundle dejavu fonts for back compat - closes #2272
package.json upgrade to node-mapnik 3.2.0 release
rebuild_cxx.sh use npm rebuild rather than direct node-gyp call to avoid sqlite3 bre…
tilemill.ico move tilemill.ico to root and add log-file option for cefclient

README.md

TileMill is a modern map design studio powered by Node.js and Mapnik.

Installation instructions, development docs and other information are available on the TileMill website.

Build Status

Build Status Build status Dependencies

Key modules

  • mapnik - Build Status
  • node-mapnik - Build Status
  • carto - Build Status
  • tilelive.js - Build Status
  • tilelive-mapnik - Build Status
  • millstone - Build Status
  • node-mbtiles - Build Status
  • node-sqlite3 - Build Status

Depends

  • Mapnik v2.3.0
  • Node.js v0.10.x or v0.8.x
  • Protobuf: libprotobuf-lite and protoc

However, node-mapnik (which depends on Mapnik and protobuf) is now packaged as a binary. So, you do not need an external Mapnik. See Installation

Installation

To install from source just do:

git clone https://github.com/mapbox/tilemill.git
cd tilemill
npm install

Then to start TileMill do:

./index.js # and then view http://localhost:20009 in your web browser

For more extended details follow:

Running tests

Install mocha and run the tests

npm install mocha
npm test

Note: the tests require a running postgres server and a postgis enabled database called template_postgis.

If you do not have a template_postgis create one like:

createdb -E UTF8 template_postgis
psql -c "CREATE EXTENSION postgis" template_postgis

If you experience failing tests here are two tips:

  1. Debug the project data by running TileMill with

    ./index.js --files=./test/fixtures/files/

  2. Try clearing the cache of test data:

    rm -rf ./test/fixtures/files/

For more info see: http://postgis.net/docs/manual-1.5/ch02.html

Documentation

TileMill documentation is kept in the mb-pages branch, which is independently managed and not merged with master.

TileMill's in-app reference available as the "Manual" (see below for syncing details) is a very small subset of docs for offline usage and is manually sync'ed from the mb-pages branch.

To view all the TileMill documentation locally, first checkout the mb-pages branch:

git checkout mb-pages

Then install Jekyll:

sudo gem install jekyll

And run Jekyll:

jekyll

Once Jekyll has started you should be able to view the docs in a browser at:

http://localhost:4000/tilemill/

Syncing manual

To sync the manual with mb-pages updates do:

export TILEMILL_SOURCES=`pwd`
cd ../
git clone --depth=1 -b mb-pages https://github.com/mapbox/tilemill tilemill-mb-pages
cd ${TILEMILL_SOURCES}
export TILEMILL_GHPAGES=../tilemill-mb-pages
rm -rf ${TILEMILL_SOURCES}/assets/manual
mkdir -p ${TILEMILL_SOURCES}/assets/manual
cp -r ${TILEMILL_GHPAGES}/assets/manual/* ${TILEMILL_SOURCES}/assets/manual/
git add ${TILEMILL_SOURCES}/assets/manual/*
rm -rf ${TILEMILL_SOURCES}/_posts/docs/reference
mkdir -p ${TILEMILL_SOURCES}/_posts/docs/reference
cp -r ${TILEMILL_GHPAGES}/_posts/docs/reference/* ${TILEMILL_SOURCES}/_posts/docs/reference/
git add ${TILEMILL_SOURCES}/_posts/docs/reference/*
Something went wrong with that request. Please try again.