CONTRIBUTING.md

Contributing

Requirements

• Node
• Docker (optional, recommended, required for Docker Compose)
• Docker Compose (optional, recommended)

Dependencies

Install the Node.js dependencies locally.

NPM

$ npm install

Docker Compose

$ docker-compose run --rm npm install

Lint

Check for code-style inconsistency errors.

NPM

$ npm run lint

Docker Compose

$ docker-compose run --rm npm run lint

Test

Check that the specification are met.

NPM

$ npm test

Docker Compose

$ docker-compose run --rm npm test

Build

Build the optimized files for the NPM package.

NPM

$ npm run build

Docker Compose

$ docker-compose run --rm npm run build