Setup & Development

Prerequisites

• Node.js 22+
• pnpm (enable via Corepack: corepack enable && corepack prepare pnpm@latest --activate)
• Docker Desktop (for PostgreSQL and other services)
• Git

Quick Start

# 1. Clone and install
git clone <repo-url> planner
cd planner
pnpm install

# 2. Start infrastructure (PostgreSQL)
docker compose up -d db

# 3. Set up environment
cp apps/backend/.env.example apps/backend/.env
# Edit .env if needed (defaults work for local Docker)

# 4. Push database schema
cd apps/backend
npx prisma db push
cd ../..

# 5. Start all apps in development mode
pnpm dev

This starts:

• Backend on http://localhost:4000
• Frontend on http://localhost:3000
• Website on http://localhost:8080
• Docs on http://localhost:8081

Environment Variables

Backend (apps/backend/.env)

DATABASE_URL="postgresql://planner:planner@localhost:5432/planner?schema=public"
JWT_SECRET="your-secret-key"
JWT_REFRESH_SECRET="your-refresh-secret-key"
UPLOAD_DIR="./uploads"

Running Individual Apps

# Backend only
pnpm --filter @planner/backend dev

# Frontend only
pnpm --filter @planner/frontend dev

# Website only
pnpm --filter @planner/website dev

# Docs only
pnpm --filter @planner/docs dev

Useful Commands

# Type checking
pnpm --filter @planner/backend typecheck
pnpm --filter @planner/frontend typecheck
pnpm --filter @planner/website build  # website has typecheck in build

# Testing
pnpm --filter @planner/backend test    # 145+ unit tests

# Build
pnpm --filter @planner/backend build
pnpm --filter @planner/frontend build
pnpm --filter @planner/website build
pnpm --filter @planner/docs build

# Lint (entire monorepo)
pnpm lint

# Database schema changes
cd apps/backend
npx prisma db push      # Apply schema to dev DB
npx prisma generate     # Regenerate Prisma client

Docker Development

# Start all services
docker compose up -d

# Rebuild a specific service
docker compose build --no-cache backend

# View logs
docker compose logs -f backend frontend

# Stop everything
docker compose down

Project Scripts

Script	Description
pnpm dev	Start all apps in dev mode
pnpm build	Build all apps
pnpm lint	Run linter across monorepo
pnpm format	Format code with Prettier