QTrees Vector Tiles Generator

This project is a pipeline to generate vector tiles based on a PGSQL Database. It uses gdal, tippecanoe and mbtileserver to generate and serve vector tiles. It is a part of the QTrees.ai project.

The pipeline consist of three parts. The

1. The base image Dockerfile.base installs all the dependencies and tools needed to generate the vector tiles and serve them
2. The generator.sh step in a GitHub Action generate.yml generates the vector tiles and pushes them to a S3 bucket (uses the base image)
3. The tileserver hosted on render.com. Dockerfile.server builds a docker image that downloads the generated .pbf from AWS S3 and serves the vector tiles (uses the base image)

Prerequisites

• Docker
• Postgres DB (also included in docker-compose.override.yml)
• render.com Account
• AWS S3 Bucket

Usage and Development

Local development is hard when trying to build ci pipelines. Happens mostly in the cloud on GitHub Actions. You could try nektos/act to run this locally.

cd path/to/repo
docker compose up -d

Tests

Currently the tests only check if the images can be built and if the mbtileserver can be started.

cd path/to/repo
docker-compose up -f docker-compose.yml -f docker-compose.test.yml

Credits

Made by

A project by

Supported by

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Fabian Morón Zirfas 💻 🎨 🤔 🚇 ⚠️

juan-carlos-tsb 💻 🎨 👀 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!