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.

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/.

Getting started with code

First, run the database in the background using Docker.

docker compose up -d db

Then launch the development API server.

pnpm nodemon src/index.ts