Windshaft-cartodb

Windshaft tailored for CARTO

  • 所有者: CartoDB/Windshaft-cartodb
  • 平台:
  • 许可证: BSD 3-Clause "New" or "Revised" License
  • 分类:
  • 主题:
  • 喜欢:
    0
      比较:

Github星跟踪图

Windshaft-CartoDB Build Status

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

Build

Requirements:

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

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.

主要指标

概览
名称与所有者CartoDB/Windshaft-cartodb
主编程语言JavaScript
编程语言JavaScript (语言数: 6)
平台
许可证BSD 3-Clause "New" or "Revised" License
所有者活动
创建于2011-09-04 23:35:06
推送于2023-09-06 09:52:20
最后一次提交2023-09-06 11:50:50
发布数311
最新版本名称9.0.0 (发布于 2020-06-05 14:11:11)
第一版名称rs090 (发布于 2012-09-21 19:08:24)
用户参与
星数73
关注者数96
派生数57
提交数6.6k
已启用问题?
问题数461
打开的问题数36
拉请求数693
打开的拉请求数22
关闭的拉请求数61
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?