/k2

3D terrain server for Cesium tiles stored as quantized meshes in MBTiles

Primary LanguageJavaScriptMIT LicenseMIT

k2

Build Status

Image

A docker container that runs a 3D terrain tiles server stored as quantized meshes in MBTiles for Cesium.

Building

Manual build

You can build the image with the following command:

docker build -t <your-image-name> .

Automatic build using Travis CI

This project is configured to use Travis to build and push the image on the Kalisio's Docker Hub. The built image is tagged using the version property in the package.json file.

To enable Travis to do the job, you must define the following variable in the corresponding Travis project:

Variable Description
DOCKER_USER your username
DOCKER_PASSWORD your password

Deploying

This image is designed to be deployed using the Kargo project.

Check out the compose file to have an overview on how the container is deployed.

Contributing

Please read the Contributing file for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

When releasing a patch, minor or major version, i.e. the following tasks have to be done:

  • increase the package version number in the package.json file
  • create a tag accordingly in the git repository and push it

The command npm run release:<type>, where <type> is either patch, minor or major, will do the job for you !

Authors

This project is sponsored by

Kalisio

License

This project is licensed under the MIT License - see the license file for details