Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 3.09 KB

README_source.adoc

File metadata and controls

40 lines (23 loc) · 3.09 KB
Raw

tilegroxy — Tile G(o) (P)roxy

Docker Image CI Go Report Card OpenSSF Scorecard Coverage Libyears
Go Version License Contributor Covenant

Tilegroxy lives between your map and your mapping providers to deliver a consistent, cached API for all your layers.

🚀 Built in Go.
🔌 Features a flexible plugin system powered by Yaegi.
💡 Inspired by tilestache
🛠️ This project is still a work in progress. Changes may occur prior to the 1.0 release.

Documentation

Prebuilt Documentation for the most recent release is available here.

Documentation is served by tilegroxy at /docs (disable this behaviour by setting Server.Production=true). Documentation is powered by Antora with raw AsciiDoc located in docs

Extending tilegroxy

One of the top design goals of tilegroxy is to be highly flexible. If there’s functionality you need, there’s a couple different ways you can add it in. See the extensibility documentation for instructions.

Contributing

As this is a young project any contribution via an Issue or Pull Request is very welcome.

A few please and thank yous:

  • Follow go conventions and the patterns you see elsewhere in the codebase. Linters are configured in Github Actions, they can be run locally with make lint

  • Use semantic / conventional commit messages.

  • Open an issue for discussion before making large, fundamental change/refactors

  • Ensure you add tests. You can use make coverage to ensure you’re not dropping coverage.

Very niche providers might be declined. Those are best suited as custom providers outside the core platform.