Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/narwassco/vt-map

Vector tile map hosted on Github pages.
https://github.com/narwassco/vt-map

mbutil tippecanoe vectortiles

Last synced: 10 days ago
JSON representation

Vector tile map hosted on Github pages.

Awesome Lists containing this project

README

        

# vt-map
![GitHub](https://img.shields.io/github/license/narwassco/vt-map)
![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/narwassco/vt-map)
![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/narwassco/vt-map)
[![Gitter](https://badges.gitter.im/narwassco/community.svg)](https://gitter.im/narwassco/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

This is a simple tool to create vector tile map on Github pages.

## This repository is no londer used. It has been moved to [narwassco/vt](https://github.com/narwassco/vt)!

## Installation
### tippecanoe
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
```

### main module
```
git clone https://github.com/narwassco/vt-map.git
npm install
```

## Configuration
All the settings are in `config.js`, so please make sure your own settings on this file before producing vector tile.

Please create `app-docker.env` file under project root directory to put environment variable for database settings.
```
export_dir=/tmp/src/vt-map

db_user=postgres
db_password=Your password
db_host=host.docker.internal
db_post=5432
db_name=narwassco
```

The stylefile `style.json` under this repository is just for checking the vector tile data.

We are managing Mapbox Stylefile in [narwassco/mapbox-stylefiles](https://github.com/narwassco/mapbox-stylefiles).

## Create vector tile from your PostGIS database by using Docker

Build Docker Image
```
docker build -t narwassco/vt-map .
```

Create Vector Tile and sprite files under public directory.
```
docker-compose up
```

## Create vector tile from your PostGIS database by using local Nodejs
It will retrieve the data from PostGIS as mbtiles format, then vector tiles (.mvt) were extracted under `public/tiles` folder.
```
npm run build
```

## Deploy to gh-pages
It will push all of website contents under public folder to Github pages.
```
npm run deploy
```

# License

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

However, these data under [public](./public) is 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.