npm scripts

This wiki page details the available npm scripts. These scripts are located in the scripts category of /package.json.

Keep in mind that this documentation uses the yarn command but using npm instead will have the same effect.

Summary

Start the server with the extract remover service.

yarn server:start

Start the server without the extract remover service.

yarn server:start

Lint and autofix the server files.

This will follow the /.eslintrc.js ESLint configuration. It will warn you for syntax misuse, indentation errors or such.

yarn server:lint

Start the web application on an hot-reload server. Development mode only. Do not use in production as it is less performant and not optimized

yarn app:dev

Build the web application files to the /dist directory. Generated files (HTML/CSS/JavaScript) are optimized for production.

yarn app:build

Lint and autofix the web application files.

This will follow the /.eslintrc.js ESLint configuration. It will warn you for syntax misuse, indentation errors or such.

yarn app:lint

Generate the API documentation to the /doc directory. When starting the server, this documentation will be available at /doc url.

yarn doc

Run the API automated tests. It will check for routes/WebSockets server/database errors.

These tests are automatically ran when using Docker.

yarn test