Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.62 KB

README.md

File metadata and controls

97 lines (69 loc) · 2.62 KB
Raw

vt

GitHub Docker Cloud Automated build Docker Image Size (latest by date) openAFRICA upload

This is to manage vectortiles for Narok Water in Github pages.

Configuration

All the settings are in config.js and config-search.js, so please make sure your own settings on this file before producing vector tile.

Please put environment variable for database settings.

db_user=$db_user
db_password=$db_password
db_host=host.docker.internal
db_port=5432

Create mbtiles

Usage (Docker)

db_user=your user db_password=your password docker-compose up

Your mbtiles will be generated under data directory.

Usage (Nodejs)

Requirements

This module uses tippecanoe to convert geojson files to mbtiles. Please make sure to install it before running.

for MacOS

$ brew install tippecanoe

for Ubuntu

$ git clone https://github.com/mapbox/tippecanoe.git
$ cd tippecanoe
$ make -j
$ make install

Then,

$ npm install

$ db_user=$db_user \
  db_password=$db_password \
  db_host=localhost \
  db_port=5432 \
  npm run create

There will be two files as follows.

  • ./data/rwss.mbtile
  • ./public/wss.geojson

Extract pbf (mvt) tiles from mbtiles file

please configure config-extact.js file to adjust output directory path and input mbtiles path.

npm run extract

There will be vectortiles under ./public/tiles directory.

Deploy

npm run deploy

It will publish all the files under public directory to Github Pages.

Using Github Action

We can use Github Action for npm run extract and npm run deploy process.

So, you can just push data/narok.mbtiles and public/meter.geojson to master repository.

License

This source code under the repository is licensed by MIT license. You can use it freely for your purposes.

However, these data under data and gh-pages branch are owned and maintained by Narok Water and Sewerage Services Company (NARWASSCO) in Kenya. It is under a Creative Commons Attribution 4.0 International License, which is different from main repository. You can use this data freely, but please mention our credit ©NARWASSCO,Ltd. on attribution of your web application.

Copyright (c) 2020 Narok Water and Sewerage Services Co., Ltd.