Set Up the Development Environment

This document helps you setting up the developer environment. It is useful if you would like to contribute to the codebase of the engine or the website.

Quick Start

After cloning the repository run these commands from the root directory.

npm install
npm start

This will compile the development version of the code and start a web server. Now you can open http://localhost:8080 to check the result.

Source Structure

The source contains the following folders.

• assets: Various assets used in the code or in any other media platforms.
• docs: Code of this documentation.
• libs: External libraries used by the solution.
• sandbox: Various examples mostly for using the engine.
• source: Source code of the engine and the website.
  • engine: Source code of the engine. It doesn't contain any website specific codes.
  • website: Source code of the website.
• test: Automatic tests for the engine.
• tools: Tools for building the library.
• website: Static resources for the website.

Scripts

Several scripts are available for building, testing and publishing.

Building

• npm run build_dev: Builds the development version of the engine and the website.
• npm run build_engine_dev: Builds the development version of the engine.
• npm run build_engine_prod: Builds the production version of the engine.
• npm run build_website_dev: Builds the development version of the website.
• npm run build_website_prod: Builds the production version of the website.

Testing

• npm run test: Runs all unit tests.
• npm run lint: Runs eslint on the codebase.

Packaging

• npm run create_package: Generates the production version of the engine and the website.
• npm run create_dist: Generates the production version of the engine and the website, and runs all the possible checks.