Go to file

Daniel García Aubert 6f9580bae2 Allow the metro to exit if this is the only active server in the event loop system		4 years ago
assets	timeout error vector with lines	7 years ago
config/environments	Replace log4js by pino as logger:	4 years ago
docker	Better script organization	5 years ago
docs	Professional -> Individual	5 years ago
lib	Introducing @carto/metro, the carto logs and metrics transport.	4 years ago
metro	Allow the metro to exit if this is the only active server in the event loop system	4 years ago
scripts	Merge pre-install scripts	5 years ago
test	typo	4 years ago
.eslintignore	Apply automatic eslint fixes	5 years ago
.eslintrc.js	Remove jshint, add eslint and config	5 years ago
.gitignore	Remove deprecated coverage dep. Use nyc instead	5 years ago
.travis.yml	Merge branch 'master' into node-12	4 years ago
HOW_TO_RELEASE.md	Minor doc fixes	5 years ago
LICENSE	Adds notes about contributing	9 years ago
NEWS.md	Update deps	4 years ago
README.md	Minor doc fixes	5 years ago
app.js	Do not bind logger to global object, now it's a part of serverOptions	4 years ago
carto-package.json	Update carto_postgresql_ext minor dependency version	5 years ago
package-lock.json	Introducing @carto/metro, the carto logs and metrics transport.	4 years ago
package.json	Introducing @carto/metro, the carto logs and metrics transport.	4 years ago

README.md

Windshaft-CartoDB

The CARTO Maps API tiler. It extends Windshaft and exposes a web service with extra functionality:

Instantiate Anonymous Maps through CARTO's map configuration (MapConfig).
Create Named Maps based on customizable templates.
Get map previews through Static Maps API.
Render maps with a large amount of data faster using Tile Aggregation.
Build advanced maps with enriched data through Analyses Extension.
Fetch tabular data from analysis nodes with Dataviews

Build

Requirements:

Node 10.x (npm 6.x)
PostgreSQL >= 10.0
PostGIS >= 2.4
CARTO Postgres Extension >= 0.24.1
Redis >= 4
libcairo2-dev, libpango1.0-dev, libjpeg8-dev and libgif-dev for server side canvas support
C++11 to build internal dependencies. When there's no pre-built binaries for your OS/architecture distribution.

Optional:

PostGIS setup

A template_postgis database is expected. One can be set up with

$ createdb --owner postgres --template template0 template_postgis
$ psql -d template_postgis -c 'CREATE EXTENSION postgis;'

Install

To fetch and build all node-based dependencies, run:

$ npm install

Run

Create the ./config/environments/<env>.js file (there are .example files to start from). Look at ./lib/server-options.js for more on config.

$ node app.js <env>

Where <env> is the name of a configuration file under ./config/environments/.

Test

$ npm test

Coverage

$ npm run cover

Open ./coverage/lcov-report/index.html.

Docker support

We provide docker images just for testing and continuous integration purposes:

You can find instructions to install Docker, download, and update images here.

Useful `npm` scripts

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

Where:

<docker-image-tag>: the tag of required docker image, e.g. carto/nodejs-xenial-pg1121:latest
<nodejs-version>: the Node.js version, e.g. 10.15.1

In case you need to debug:

$ DOCKER_IMAGE=<docker-image-tag> npm run docker:bash

Documentation

You can find an overview, guides, full reference, and support in CARTO's developer center. The docs directory contains different documentation resources, from a higher level to more detailed ones.

Contributing

The issue tracker: Github.
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.

Developing with a custom `Windshaft` version

If you plan or want to use a custom / not released yet version of windshaft (or any other dependency), the best option is to use npm link. You can read more about it at npm-link: symlink a package folder.

$ cd /path/to/Windshaft
$ npm install
$ npm link
$ cd /path/to/Windshaft-cartodb
$ npm link windshaft

Versioning

We follow SemVer for versioning. For available versions, see the tags on this repository.

License

This project is licensed under the BSD 3-clause "New" or "Revised" License. See the LICENSE file for details.