Installation Prerequisites

Software you need before running the kit locally.

Minimum tools:

  • Node.js >=20.10.0
  • pnpm
  • Git
  • PostgreSQL access, either through Docker or a hosted/local database

Docker is the easiest local setup because the repo already ships a compose file for PostgreSQL and Mailpit.

pnpm compose:dev:up

This starts:

  • PostgreSQL 17 on localhost:54333
  • Mailpit on localhost:8025 and localhost:1025

Alternative: Existing Database

If you already have PostgreSQL elsewhere, point DATABASE_URL at it instead of using Docker.

Drizzle Studio

Open Drizzle Studio with:

pnpm --filter "@kit/database" drizzle:studio

The exact URL is determined by drizzle-kit studio at runtime.

Common Pitfalls

  • Docker not running before pnpm compose:dev:up
  • forgetting that PostgreSQL is only required if you are not using the bundled Docker setup
  • blocked local ports 54333, 8025, or 1025

Next: Clone Repository →