{"id":15058942,"url":"https://github.com/protomaps/basemaps","last_synced_at":"2025-05-14T15:06:21.224Z","repository":{"id":48663348,"uuid":"258443134","full_name":"protomaps/basemaps","owner":"protomaps","description":"Basemap PMTiles generation and cartographic styles for OpenStreetMap data and more","archived":false,"fork":false,"pushed_at":"2025-05-08T07:42:14.000Z","size":4110,"stargazers_count":468,"open_issues_count":35,"forks_count":65,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-05-08T08:37:02.551Z","etag":null,"topics":["cartography","maplibre","maps","openlayers","openstreetmap","pmtiles"],"latest_commit_sha":null,"homepage":"https://maps.protomaps.com/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protomaps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"protomaps"}},"created_at":"2020-04-24T07:46:47.000Z","updated_at":"2025-05-08T05:57:52.000Z","dependencies_parsed_at":"2024-05-06T07:48:54.711Z","dependency_job_id":"b06f7b6b-547f-4594-961c-aea98a424876","html_url":"https://github.com/protomaps/basemaps","commit_stats":null,"previous_names":["protomaps/protomaps-themes"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2Fbasemaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2Fbasemaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2Fbasemaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2Fbasemaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protomaps","download_url":"https://codeload.github.com/protomaps/basemaps/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254169058,"owners_count":22026207,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cartography","maplibre","maps","openlayers","openstreetmap","pmtiles"],"created_at":"2024-09-24T22:33:53.800Z","updated_at":"2025-05-14T15:06:21.187Z","avatar_url":"https://github.com/protomaps.png","language":"Java","funding_links":["https://github.com/sponsors/protomaps"],"categories":[],"sub_categories":[],"readme":"# Protomaps Basemaps\n\nBuild a cartographic \"basemap\" PMTiles from OpenStreetMap + other datasources, plus MapLibre styles for displaying them in a browser.\n\nTo get started, check out some basic examples:\n\n* [display markers on a map](https://maps.protomaps.com/examples/basic.html)\n* [change the map theme and language](https://maps.protomaps.com/examples/theme_language.html)\n* [sandwich data between map layers](https://maps.protomaps.com/examples/data_sandwich.html)\n\nThis repository is organized into parts:\n\n* `app`: A single-page app, [maps.protomaps.com](maps.protomaps.com) for viewing and downloading basemap builds.\n* `tiles/`: A [Planetiler](https://github.com/onthegomap/planetiler) build profile that generates `planet.pmtiles` from OpenStreetMap and Natural Earth in 2-3 hours on a modest computer.\n* `styles/`: A TypeScript package that generates [MapLibre GL](http://github.com/maplibre) styles, in multiple color themes, that can be used via `npm` or exported as JSON.\n\nAssets such as fonts and sprites are hosted and downloadable at the [basemaps-assets](https://github.com/protomaps/basemaps-assets) repository.\n\n## Development\n\nYou will need [Java 21+](https://github.com/onthegomap/planetiler/blob/main/CONTRIBUTING.md) and [Maven](https://maven.apache.org/install.html) installed, which is available in most package managers.\n\nGenerate and inspect a basemap PMTiles of any named area:\n\n1. Clone this repository.\n\n```shell\ngit clone git@github.com:protomaps/basemaps.git\n```\n2. change to the `tiles` directory, download dependencies and compile the JAR:\n\n```shell\ncd basemaps/tiles\nmvn clean package\n```\n3. Download and generate `monaco.pmtiles` in the current directory:\n\n```shell\njava -jar target/*-with-deps.jar --download --force --area=monaco\n```\n\n4. Switch to the `app/` directory to run the map frontend:\n\n```shell\ncd app\nnvm use\nnpm ci\nnpm run dev\n```\n\nThe locally generated pmtiles can be fetched from http://localhost:5173/monaco.pmtiles\n\n5. Linting to apply code formatting\n\n```shell\nmvn spotless:apply\n```\n\n## Licensing and Attribution Guidelines\n\nSummary:\n\n* All code is BSD-3\n* Map design is CC0\n* Tilesets are ODbL, attribute OSM\n* We like shoutouts!\n* Name your fork, commercial product or service something different\n\nWe kindly request that you attribute the Protomaps project if you use the basemap styles unmodified or with additions, but you are not required to do so. The visual design copyright of the maps is released under a [Creative Commons Zero (CC0) license](https://creativecommons.org/publicdomain/zero/1.0/) to eliminate ambiguity around derivative or combined works of map styling code, and to publish software, such as NPM packages, under the standard BSD-3 license.\n\nThe tilesets that power the Protomaps basemap are [Produced Works of the OpenStreetMap dataset](https://osmfoundation.org/wiki/Licence/Community_Guidelines/Produced_Work_-_Guideline) under the [Open Database License](https://www.openstreetmap.org/copyright). Web maps and native apps that use this Produced Work must visibly attribute © OpenStreetMap - for example, in the corner of the map display. If your map only uses the Map Styles with non-OpenStreetMap tilesets, this attribution is not required.\n\nExample web map corner attribution:\n\n```html\n\u003ca href=\"https://github.com/protomaps/basemaps\"\u003eProtomaps\u003c/a\u003e © \u003ca href=\"https://openstreetmap.org\"\u003eOpenStreetMap\u003c/a\u003e\n```\n\nTilesets also include data from [Natural Earth](https://www.naturalearthdata.com) and other sources, which does not require corner attribution. Other data sources your map uses may require additional attribution: See [LICENSE_DATA.md](/LICENSE_DATA.md).\n\nDepending on map style, MIT-licensed icons may also be included from the [Tangram Icons repository](https://github.com/tangrams/icons/issues).\n\nThe software in this repository is made available under a [BSD 3-Clause License](/LICENSE.md), and includes license notices related to Protomaps LLC, Mapzen, and the Linux Foundation. You must retain these license notices in software source code derived from this repository.\n\nIf you distribute a modified “fork” of these basemap styles or tilesets, or provide a tiles API based on them, you must name your product or service something different from Protomaps. Free and unmodified redistributions of tiles and styles are permitted to use the name. No restrictions apply to the underlying technology `.pmtiles` which is an [open specification in the public domain.](https://github.com/protomaps/PMTiles#license)\n\nThese guidelines are subject to change with the addition of other open datasets. Any questions can be addressed to [support@protomaps.com](mailto:support@protomaps.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotomaps%2Fbasemaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotomaps%2Fbasemaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotomaps%2Fbasemaps/lists"}