grindhead / reels Goto Github PK

Main features:

• Source Map support
• Incremental Build
• Unit tests
• Browser Hot Reload

Main dependencies:

• Application Server: Node
• Compiler: TypeScript
• Bundler: Webpack
• Unit Test Runner: Mocha
• Pixi.js: Pixi.js

Node, TypeScript and TSLint should be installed globally.

$> git clone https://github.com/Grindheadhead/Reels.git <new folder>
$> cd <new folder>
$> git init
$> yarn install

Commands should be run under a bash shell.

The following command builds and run the project in development mode with Hot Reload.

$> yarn serve

The following command builds the project in production mode. Project will output into a dist folder

$> yarn build

For more predefined commands, see package.json.

Texture atlases have been generated using TexturePacker.

Sounds are generated using Audiosprite via the command audiosprite --output audiosprite \*.mp3 -f howler

Documentation can be generated by running

$> yarn docs

$> yarn ts-coverage

MIT

With thanks to https://github.com/yahiko00/PixiProject.git for the boilerplate