Quick Start
Get the application running locally in a few minutes.
This guide gets a local development environment up and running.
Prerequisites
Before you begin, make sure you have:
- Node.js 22 or higher
- pnpm as the package manager
- Docker for the local database
- Git for version control
Step 1: Install dependencies
From the repository root, install everything with a single command:
pnpm install
Step 2: Start the database
The app talks to a local Postgres instance. Start it with the provided compose file:
pnpm --filter <app> db:up
Step 3: Apply the schema
Bring the database up to date with the app's migrations:
pnpm --filter <app> ionite apply
Step 4: Run the dev server
pnpm --filter <app> dev
The application will be available at the local URL printed in your terminal.
Step 5: Create an account
Open the app, go to the sign-up page, and request a one-time code. In development the code is delivered to your terminal or local mail catcher — enter it to finish signing in.
Next steps
With the app running, read the project structure guide to learn your way around the codebase.