# editor-api

**Repository Path**: Fan270/editor-api

## Basic Information

- **Project Name**: editor-api
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-01
- **Last Updated**: 2023-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Overview

This is the PlayCanvas Editor API. You can find API documentation [here](docs/modules.md).

# Installing
Run:
```
npm install
```

# Building

Run:
```
npm run build
```

This will create a UMD build under `dist/index.js` and an ES6 module under `dist/index.mjs`.

# Docs

To build the documentation run:
```
npm run build:docs
```

The resulting .md file will be under docs/modules.md.

NOTE: Build the docs after you commit any API changes, otherwise the code links in the docs might point to the wrong lines.

NOTE: The following documents are created externally. When you build the docs, revert those documents (or update them externally):
* `EntityProperties.md`
* `AssetProperties.md`
* `SceneSettingsProperties.md`

# Tests

To run tests run:
```
npm test
```

To step through the tests using Chrome run:
```
npm run test:debug
```