mlpcardgame/README.md
2019-09-20 15:02:59 +02:00

1.2 KiB

MLPCARDGAME

Build Status

Work in progress name, work in progress game

Try the latest build here: mcg-builds.zyg.ovh/latest

Development

Dependencies

Fetch dependencies with yarn:

yarn --dev

Run local server for development

Run this command:

yarn serve

then visit localhost:8080 (URL might be different if something is already listening on port 8080)

Run tests

Run unit tests with Jest:

yarn test:unit

Generate a coverage profile with:

yarn test:unit --coverage

Lint code

Before you submit a PR, make sure the code is formatted correctly with:

yarn lint

Building for release

Build

yarn build

License

Code is ISC, Assets "depends", some stuff is taken from FreeSound and DeviantArt so your best bet is to just praise the copyright gods.

PeerJS mocking is based on works by Rolf Erik Lekang, which is licensed under MIT. Check peerjs-mock for more details.