-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from govlt/readme
Licence and Readme
- Loading branch information
Showing
2 changed files
with
115 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 Office of the Government of the Republic of Lithuania | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # National Boundaries Vector Tiles of Lithuania | ||
|
|
||
| Access simplified and regularly updated vector tiles of national boundaries in Lithuania from the Address Registry. | ||
|
|
||
| ## Key Features | ||
|
|
||
| 1. **Ready to Use**: Pre-simplified and ready-to-serve vector tiles. | ||
| 2. **Easy Hosting**: Available as a single-file PMTiles archive, easily hosted on platforms like S3. | ||
| 3. **Regular Updates**: Daily updates reflecting boundary changes. | ||
| 4. **Available Hosted Versions**: Hosted versions of boundaries are readily available for direct use. | ||
| 5. **Open Source**: Free and open-source. Join our community of contributors. | ||
|
|
||
| ## Usage | ||
|
|
||
| For details on using PMTiles, check the [PMTiles in the browser](https://docs.protomaps.com/pmtiles/maplibre) | ||
| documentation. | ||
|
|
||
| ### Hosted Versions | ||
|
|
||
| Use hosted versions of boundaries on your website, with global low latency and high SLA via Cloudflare Pages. | ||
|
|
||
| | Type | Lithuanian Translation | Demo | PMTiles Archive URL | | ||
| |-----------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | ||
| | **Counties** | Apskričių ribos | [Demo](https://pmtiles.io/?url=https%3A%2F%2Fboundaries.startupgov.lt%2Fpmtiles%2Fcounties.pmtiles#map=6.95/55.191/22.92) | [counties.pmtiles](https://boundaries.startupgov.lt/pmtiles/counties.pmtiles) | | ||
| | **Municipalities** | Savivaldybių ribos | [Demo](https://pmtiles.io/?url=https%3A%2F%2Fboundaries.startupgov.lt%2Fpmtiles%2Fmunicipalities.pmtiles#map=6.95/55.191/22.92) | [municipalities.pmtiles](https://boundaries.startupgov.lt/pmtiles/municipalities.pmtiles) | | ||
| | **Elderships** | Seniūnijų ribos | [Demo](https://pmtiles.io/?url=https%3A%2F%2Fboundaries.startupgov.lt%2Fpmtiles%2Felderships.pmtiles#map=6.95/55.191/22.92) | [elderships.pmtiles](https://boundaries.startupgov.lt/pmtiles/elderships.pmtiles) | | ||
| | **Residential Areas** | Gyvenamųjų vietovių ribos | - | Not Available | | ||
| | **Streets** | Gatvių ribos | [Demo](https://pmtiles.io/?url=https%3A%2F%2Fboundaries.startupgov.lt%2Fpmtiles%2Fstreets.pmtiles#map=11/54.6828/25.2686) | [streets.pmtiles](https://boundaries.startupgov.lt/pmtiles/streets.pmtiles) | | ||
|
|
||
| ### Self-Hosting | ||
|
|
||
| Download the latest PMTiles archives and host them on your own server. | ||
|
|
||
| | Type | Lithuanian Translation | PMTiles Archive URL | | ||
| |-----------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Counties** | Apskričių ribos | [counties.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/counties.pmtiles) | | ||
| | **Municipalities** | Savivaldybių ribos | [municipalities.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/municipalities.pmtiles) | | ||
| | **Elderships** | Seniūnijų ribos | [elderships.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/elderships.pmtiles) | | ||
| | **Residential Areas** | Gyvenamųjų vietovių ribos | [residential-areas.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/residential-areas.pmtiles) | | ||
| | **Streets** | Gatvių ribos | [streets.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/streets.pmtiles) | | ||
|
|
||
| ## Architecture | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| ar["State Enterprise Centre of Registers\n<a href='https://www.registrucentras.lt/p/1187'>Address Registry raw data</a>"] | ||
| --> transform["<a href='https://github.com/govlt/national-boundaries/blob/main/create-geopackage.sh'>Create GeoPackage</a>"] | ||
| --> |"<a href='https://github.com/govlt/national-boundaries/releases/latest/download/boundaries-4326.gpkg'>boundaries-4326.gpkg</a>"|github-releases | ||
| github-releases["<a href='https://github.com/govlt/national-boundaries/releases'>GitHub Releases</a>"]--> cloudflare-pages["Cloudflare Pages"] | ||
| cloudflare-pages-->pages-counties["<a href='https://boundaries.startupgov.lt/pmtiles/counties.pmtiles'>counties.pmtiles</a>"] | ||
| cloudflare-pages-->pages-municipalities["<a href='https://boundaries.startupgov.lt/pmtiles/municipalities.pmtiles'>municipalities.pmtiles</a>"] | ||
| cloudflare-pages-->pages-elderships["<a href='https://boundaries.startupgov.lt/pmtiles/elderships.pmtiles'>elderships.pmtiles</a>"] | ||
| cloudflare-pages-->pages-streets["<a href='https://boundaries.startupgov.lt/pmtiles/streets.pmtiles'>streets.pmtiles</a>"] | ||
| ``` | ||
|
|
||
| ## Development Setup | ||
|
|
||
| - **Install Java 21+**: Ensure Java is installed for running the mapping engine. | ||
|
|
||
| ### Generating Tiles | ||
|
|
||
| To generate the tiles in PMTiles format: | ||
|
|
||
| ```shell | ||
| make generate | ||
| ``` | ||
|
|
||
| Find the output in `data/output`. | ||
|
|
||
| ### Previewing | ||
|
|
||
| Ensure [Docker](https://www.docker.com/get-started/) (version 2.22+ preferred) is installed. Then, run: | ||
|
|
||
| ```shell | ||
| make preview | ||
| ``` | ||
|
|
||
| This will start [Tileserver-GL](https://github.com/maptiler/tileserver-gl) at http://localhost:8080 for previewing. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](./LICENSE). Data is licensed | ||
| under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.lt). For more information, | ||
| visit [Registrų centras](https://www.registrucentras.lt/p/1187). | ||
|
|
||
| While preparing the National Boundaries Vector Tiles, some changes were made, such as changing attribute names to | ||
| English. For full details, check out the [create-geopackage.sh](./create-geopackage.sh) file. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions! For details, see | ||
| our [contribution guidelines](https://github.com/govlt/.github/blob/main/CONTRIBUTING.md). |