Skip to content
OpenCodeHub Docs

Local Development Setup

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+ (project engines specify Node 20+ for runtime)
  • Git 2.30+
  • PostgreSQL/MySQL/SQLite (PostgreSQL recommended)

Install dependencies

Section titled “Install dependencies”
Terminal window
npm install

Environment

Section titled “Environment”
Terminal window
cp .env.example .env

Set required values like JWT_SECRET, SESSION_SECRET, INTERNAL_HOOK_SECRET, and SITE_URL.

Database

Section titled “Database”
Terminal window
npm run db:push

Seed admin user

Section titled “Seed admin user”
Terminal window
bun run scripts/seed-admin.ts

Run dev server

Section titled “Run dev server”
Terminal window
npm run dev

Open the app at http://localhost:3000.

Useful scripts

Section titled “Useful scripts”
  • npm run db:generate
  • npm run db:migrate
  • npm run db:studio
  • npm run lint
  • npm run test