instructions.md

Instructions

This section lists instructions for various things you might need to do in this repo.

Install the dependencies:

npm install

Start the application:

npm run zap

Start the front-end in development mode:

(Supports hot-code reloading, error reporting, etc.)

quasar dev -m electron

or

npm run electron-dev

Environment variables:

Following is the list of environment variables that zap tool honors:

• ZAP_LOGLEVEL: pino log level to start with. Default is 'warn'. You can use 'debug' or 'info', for example.

Format the files:

Format staged files in Git to follow prettier.io code format.

For development, IDE integration can be found here.

This command is called via pre-commit Git hook as well.

npm run format-code

Lint the files:

npm run lint

Build the app for production:

quasar build -m electron

or

npm run electron-build

Run the unit tests:

npm run test

Regenerate the API documentation:

npm run apidoc

Customize the configuration:

See Configuring quasar.conf.js.