- Can render arbitrary SQL queries
- Generates image and UTFGrid interactivity tiles
- Accepts, stores, serves, and applies map styles written in
- Supports re-projections
Windshaft is a library used by
CARTO, a location intelligence and data visualization tool.
Node 10.x (npm 6.x)
PostgreSQL >= 10.0
PostGIS >= 2.4
CARTO Postgres Extension >= 0.24.1
Redis >= 4
libgif-devfor server side canvas support
C++11to build internal dependencies. When there's no pre-built binaries for your OS/architecture distribution.
To fetch and build all node-based dependencies, run:
$ npm install
Note: only needed while developing
node-mapnik comes compiled for some platforms and architectures, in case you need it you can always compile, package and install it manually. The recommended option is via binaries, see
mason and install
$ mason install mapnik <version>
<version> is the latest released version of
Mapnik. You can also use other alternatives:
Probably one of the more advanced uses of
Windshaft library can be found at
$ npm test
$ npm run cover
We provide docker images just for testing and continuous integration purposes:
You can find instructions to install Docker, download, and update images here.
Run test in a docker image with a specific Node.js version:
$ DOCKER_IMAGE=<docker-image-tag> NODE_VERSION=<nodejs-version> npm run test:docker
<docker-image-tag>: the tag of required docker image, e.g.
<nodejs-version>: the Node.js version, e.g.
In case you need to debug:
$ DOCKER_IMAGE=<docker-image-tag> npm run docker:bash
Fonts: Invalid value for text-face-name
You need to install fonts at system level to be able to use them. If you face an issue like
Invalid value for text-face-name, the type font is expected. DejaVu Sans Book (of type string) was given. probably you don't have the required fonts, try to install DejaVu fonts or any other font needed.
- The issue tracker:
- We love Pull Requests from everyone, see contributing to Open Source on GitHub.
- You'll need to sign a Contributor License Agreement (CLA) before submitting a Pull Request. Learn more here.
This project is licensed under the BSD 3-clause "New" or "Revised" License. See the LICENSE file for details.