https://github.com/narwassco/vt

This is to manage vectortiles for Narok Water in Github pages.
https://github.com/narwassco/vt

docker github-page mbtiles tippecanoe vectortiles

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/narwassco/vt
• Owner: narwassco
• License: mit
• Created: 2020-08-08T00:16:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-09T13:48:40.000Z (9 months ago)
• Last Synced: 2024-10-28T04:24:09.542Z (9 months ago)
• Topics: docker, github-page, mbtiles, tippecanoe, vectortiles
• Language: JavaScript
• Homepage: https://narwassco.github.io/vt/tiles/{z}/{x}/{y}.mvt
• Size: 414 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vt

![](https://github.com/narwassco/vt/workflows/Node.js%20CI/badge.svg)

![GitHub](https://img.shields.io/github/license/narwassco/vt)

![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/narwassco/vt)

![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/narwassco/vt)

![openAFRICA upload](https://github.com/narwassco/vt/workflows/openAFRICA%20upload/badge.svg)

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`](https://github.com/mapbox/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](./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](http://creativecommons.org/licenses/by/4.0/), 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.