{"id":18542159,"url":"https://github.com/heremaps/xyz-maps","last_synced_at":"2025-04-05T06:03:54.928Z","repository":{"id":38738969,"uuid":"226365229","full_name":"heremaps/xyz-maps","owner":"heremaps","description":"XYZ Maps is an open-source map editor written in TypeScript.","archived":false,"fork":false,"pushed_at":"2024-10-29T10:09:41.000Z","size":11688,"stargazers_count":61,"open_issues_count":7,"forks_count":18,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-10-29T12:13:17.712Z","etag":null,"topics":["3d","geojson","geospatial","map","map-editing","map-editor","webgl"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heremaps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-06T16:09:16.000Z","updated_at":"2024-10-29T10:09:45.000Z","dependencies_parsed_at":"2023-02-18T10:47:03.659Z","dependency_job_id":"5ea3ef58-729e-42d2-9802-69ee0b99d392","html_url":"https://github.com/heremaps/xyz-maps","commit_stats":{"total_commits":1017,"total_committers":6,"mean_commits":169.5,"dds":0.05506391347099315,"last_synced_commit":"0c1940224460abb7139f0884e6f29f9f0cd5deb6"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heremaps%2Fxyz-maps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heremaps%2Fxyz-maps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heremaps%2Fxyz-maps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heremaps%2Fxyz-maps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heremaps","download_url":"https://codeload.github.com/heremaps/xyz-maps/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294516,"owners_count":20915340,"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":["3d","geojson","geospatial","map","map-editing","map-editor","webgl"],"created_at":"2024-11-06T20:07:34.655Z","updated_at":"2025-04-05T06:03:54.902Z","avatar_url":"https://github.com/heremaps.png","language":"TypeScript","readme":"# XYZ Maps JS\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n![Actions Status](https://github.com/heremaps/xyz-maps/workflows/Build%20\u0026%20Test/badge.svg)\n![Actions Status](https://github.com/heremaps/xyz-maps/workflows/Docs%20\u0026%20Playground/badge.svg)\n![npm version](https://img.shields.io/npm/v/@here/xyz-maps-editor.svg)\n\nXYZ Maps is an experimental and work in progress open-source map editor written in TypeScript/JavaScript.\n\n[![edit buildings with xyz-editor](packages/display/assets/xyz-maps.png)](https://heremaps.github.io/xyz-maps/playground/#Display-Pitch_and_Rotate_Map)\n\n* [API Playground](https://heremaps.github.io/xyz-maps/playground/#Display-Pitch_and_Rotate_Map)\n* [Documentation](https://heremaps.github.io/xyz-maps/docs/)\n\n## Overview\nXYZ Maps consists of the following main modules:\n* [@here/xyz-maps-common](packages/common) : The Common module provides commonly used javascript functionality that is required by all other modules of XYZ Maps.\n* [@here/xyz-maps-core](packages/core) : The Core module provides the most basic functionality. Main functionalities of the module are: DataProviders, TileLayers, Geometric Classes and Styling definitions.\n* [@here/xyz-maps-display](packages/display) : The Display module is a highly customizable vector map display that's optimized for map editing, larger raw datasets and frequently changing data.\n* [@here/xyz-maps-editor](packages/editor) : The Editor module provides an API for editing map data that can be used to easily access, add, remove and edit various types of map data.\n\n## Prerequisites\n\n* [Node.js](https://nodejs.org) (\u003e=20.0.0)\n* [Yarn](https://yarnpkg.com/en/docs/install) (\u003e=1.22.0)\n\n\n## Start developing\n\n1. Clone this repository\n\n    ```\n    git clone https://github.com/heremaps/xyz-maps.git\n\n    cd xyz-maps\n    ```\n\n2. Install node module dependencies\n    ```\n    yarn install\n    ```\n\n3. watch for source code changes and build dev version\n    ```\n    yarn run watch-dev\n    ```\n    Builds are located in `./packages/*/dist/`\n\n\n## Setup your XYZ token\n\nSetup an XYZ token is only required if the XYZ Hub endpoint at xyz.api.here.com is used.\nYou can get a token by following the instructions in this [guide](https://www.here.xyz/api/getting-token/).\n\nIf you are using a [local XYZ Hub](https://github.com/heremaps/xyz-hub#getting-started) simply set `set-access-token` to an empty string.\n\nRunning integration tests / playground and debug pages requires the XYZ token to be provided.\n\n* Configure your XYZ token\n    ```\n    yarn run set-access-token YOUR_ACCESS_TOKEN\n    ```\n\n## Serve debug page\n\n* Start debug server (requires xyz access token)\n    ```\n    yarn run server\n    ```\n    browser will start and open http://localhost:8080/debug automatically\n\n\n\n## Serve Playground\n\n* Build and start the playground (requires xyz access token)\n    ```\n    yarn run playground\n    ```\n    browser will start and open http://localhost:8081/packages/playground/dist automatically\n\n\n## Other Commands\n\n* Run tests on release build `yarn run test`\n\n* Build development version `yarn run build-dev` (located in docs/)\n\n* Build release version only `yarn run build-release` (minified...)\n\n* Build the documentation `yarn run build-doc` (located in packages/docs/dist/)\n\n* Create full release bundle `yarn run bundle-release` (includes documentation and playground)\n\n* Configure XYZ access token `yarn run set-access-token YOUR_ACCESS_TOKEN`\n\n\n## Guides\n\n* [Getting started](https://github.com/heremaps/xyz-maps/wiki/Getting-started)\n* [Display your space](https://github.com/heremaps/xyz-maps/wiki/Display-your-space)\n* [Style your data](https://github.com/heremaps/xyz-maps/wiki/Style-your-data)\n* [Add interactivity](https://github.com/heremaps/xyz-maps/wiki/Add-interactivity)\n\n\n## License\n\nCopyright (C) 2019-2021 HERE Europe B.V.\n\nThis project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheremaps%2Fxyz-maps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheremaps%2Fxyz-maps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheremaps%2Fxyz-maps/lists"}