Prerequisites
If you are new to the codebase, complete the Prerequisites first, then follow Project Setup.Steps
1. Set Up Database
- Docker (Recommended)
- Local PostgreSQL
First, replace Use the API shortcuts if you need them:
YOUR_DB_NAME (the value of POSTGRES_DB) in
apps/api/docker-compose.yml with a real database name (required). You can
optionally change the default user or password. Make sure the name matches
the DATABASE_URL you set in .env.2. Configure Environment
DATABASE_URL is required to boot the API. Most
integrations (auth, payments, SMS, AI, uploads) can stay unset until you enable
them in their respective guides.
When you do enable auth, set BETTER_AUTH_SECRET to a secure value (32+ chars).
You can generate one with:
DATABASE_URL in .env to
match.
3. Run Migrations
pnpm db:generate to create the Prisma client.
4. Start the Backend
The mobile app needs the API and database running to work end-to-end. If the
backend is not running, sign-in and data fetches will fail.