Skip to content
/ xyz-maps Public
forked from heremaps/xyz-maps

XYZ Maps is an open-source map editor written in TypeScript.

License

Notifications You must be signed in to change notification settings

lceni/xyz-maps

 
 

Repository files navigation

XYZ Maps JS

License Actions Status Actions Status npm version

XYZ Maps is an experimental and work in progress open-source map editor written in TypeScript/JavaScript.

edit buildings with xyz-editor

Overview

XYZ Maps consists of the following main modules:

  • @here/xyz-maps-common : The Common module provides commonly used javascript functionality that is required by all other modules of XYZ Maps.
  • @here/xyz-maps-core : The Core module provides the most basic functionality. Main functionalities of the module are: DataProviders, TileLayers, Geometric Classes and Styling definitions.
  • @here/xyz-maps-display : The Display module is a highly customizable vector map display that's optimized for map editing, larger raw datasets and frequently changing data.
  • @here/xyz-maps-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.

Prerequisites

Start developing

  1. Clone this repository

    git clone https://github.com/heremaps/xyz-maps.git
    
    cd xyz-maps
    
  2. Install node module dependencies

    yarn install
    
  3. watch for source code changes and build dev version

    yarn run watch-dev
    

    Builds are located in ./packages/*/dist/

Setup your XYZ token

Setup an XYZ token is only required if the XYZ Hub endpoint at xyz.api.here.com is used. You can get a token by following the instructions in this guide.

If you are using a local XYZ Hub simply set set-access-token to an empty string.

Running integration tests / playground and debug pages requires the XYZ token to be provided.

  • Configure your XYZ token
    yarn run set-access-token YOUR_ACCESS_TOKEN
    

Serve debug page

Serve Playground

Other Commands

  • Run tests on release build yarn run test

  • Build development version yarn run build-dev (located in docs/)

  • Build release version only yarn run build-release (minified...)

  • Build the documentation yarn run build-doc (located in packages/docs/dist/)

  • Create full release bundle yarn run bundle-release (includes documentation and playground)

  • Configure XYZ access token yarn run set-access-token YOUR_ACCESS_TOKEN

Guides

License

Copyright (C) 2019-2021 HERE Europe B.V.

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details

About

XYZ Maps is an open-source map editor written in TypeScript.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.9%
  • JavaScript 2.0%
  • HTML 2.0%
  • Other 1.1%