# heremaps_xyz-editor

**Repository Path**: mirrors-gis/heremaps_xyz-editor

## Basic Information

- **Project Name**: heremaps_xyz-editor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-21
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XYZ Editor JS
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Build Status](https://travis-ci.com/heremaps/xyz-editor.svg?branch=master)](https://travis-ci.com/heremaps/xyz-editor)
![npm version](https://img.shields.io/npm/v/@here/xyz-maps-editor.svg)

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

![edit buildings with xyz-editor](packages/docs/xyz-maps.png)

## Prerequisites

* [Node.js](https://nodejs.org) (8.16.0+)
* [Yarn](https://yarnpkg.com/en/docs/install) (1.11.0+)


## Start developing

1. Clone this repository

    ```
    git clone https://github.com/heremaps/xyz-editor.git

    cd xyz-editor
    ```

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](https://www.here.xyz/api/getting-token/).

If you are using a [local XYZ Hub](https://github.com/heremaps/xyz-hub#getting-started) 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

* Start debug server (requires xyz access token)
    ```
    yarn run server
    ```
    browser will start and open http://localhost:8080/debug automatically



## Serve Playground

* Build and start the playground (requires xyz access token)
    ```
    yarn run playground
    ```
    browser will start and open http://localhost:8081/packages/playground/dist automatically


## Other Commands

* Run tests on release build `yarn run test`

* Build development version `yarn run build-dev` (located in packages/*/dist/)

* 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

* [Getting started](https://github.com/heremaps/xyz-editor/wiki/Getting-started)
* [Display your space](https://github.com/heremaps/xyz-editor/wiki/Display-your-space)
* [Style your data](https://github.com/heremaps/xyz-editor/wiki/Style-your-data)
* [Add interactivity](https://github.com/heremaps/xyz-editor/wiki/Add-interactivity)


## License

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

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