The backend provides a REST API as well as WebSocket connections to notify clients about updates. In production, it also serves the Console frontend.

In order to run a development version on your local system, you need a Node.js environment, and a MariaDB instance.

• Clone the repository and run npm install in this folder to install all the dependencies.
• In the config/ folder, copy the file development.json to local-development.json.
• At least set the mysql property of local-development.json to set up the database connection (e.g. mysql:https://user:password@localhost:3306/database).

Start the development server by running npm run dev, it will automatically restart when files have changed. Now you can access the server on http:https://localhost:3030.

Before the first run, and whenever you work on database migration scripts, you'll have to run npm run start once. Unfortunately, running npm run dev does not take the migration scripts into account.

This project uses the following libraries or frameworks, please refer to their documentation as well.

• FeathersJS