Whiteboard server

Backend for our whiteboard.

Project setup with docker

To build and run the server simply execute

docker compose up

or to run in background

docker compose up -d

Then you can stop the containers with

docker compose stop

See developing tips for instructions on how to work with containers in VS Code.

Running checks

When using docker this should be done inside the container.

Type check

To perform only type checking you can run:

npm run type-check

Lint with ESLint

To validate:

npm run lint-check

To run lint and fix:

npm run lint

Format

To format:

npm run format

To check formating:

npm run format-check

Please run format, lint and type checks before each commit.

Manual project setup

Setup database

First you need to install redis on your device with your system's package menager. Then simply run:

redis-server --port 9000 --daemonize yes

Install node dependencies

npm ci

Run with Hot-Reloads for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build