Developer documentation

Architecture

The project is split in two different parts: the frontend, which sits in the app folder and the API, which is located in the server folder.

Getting started

Requirements

You need Docker to develop on this project easily.

OBS with VLC input sources and WebSocket server is required.

This project is currently using pnpm as a package manager. Be sure to use it too, to ensure proper module resolution. Documentation can be found at https://pnpm.io/.

Development workflow

Start and configure OBS

In OBS, open the WebSocket server settings. Add a password, and start the server.

Run a database locally

Run the database in the background using Docker.

docker compose up -d db

Run the server in development mode

Go to ./server. Copy the .env.example file to .env. Fill it with your values.

Then launch the development API server.

pnpm dev