Development

Treibstoff contains a set of shell scripts to ease setup of development environment, running tests, building docs and do deployment.

All scripts must be executed from the repository root.

Install development environment:

./scripts/install.sh

Cleanup development environment:

./scripts/clean.sh

Run tests:

./scripts/karma.sh

To view coverage report, open in browser:

karma/coverage/[browser name]/index.html

Create Javascript bundles:

./scripts/rollup.sh

Automatically build JS bundles while development:

./scripts/watch.sh

Create NPM package:

./scripts/pack.sh

Create Python package:

./scripts/wheel.sh

Build documentation:

./scripts/docs.sh