Skip to content

Quickstart

Get Reggie running locally in 5 minutes.

Prerequisites

  • Node.js 20+ and npm
  • Python 3.11 (brew install python@3.11)
  • OrbStack (brew install --cask orbstack) -- lightweight Docker runtime
  • PostgreSQL client (brew install libpq && brew link libpq --force)

Setup

git clone https://github.com/askendrew/reggie.git
cd reggie
make setup    # Installs deps, creates venv, generates .env files

Start Development

make dev      # Starts Postgres + frontend + backend

This starts: - Web app: http://localhost:3000 - Admin app: http://localhost:3001 - API docs: http://localhost:8000/api/v1/docs - Auth: Sign up via Clerk UI in the nav (keyless mode -- no Clerk account needed)

Verify It Works

  1. Open http://localhost:3000 -- you should see the Reggie homepage
  2. Open http://localhost:8000/api/v1/docs -- Swagger UI with all API endpoints
  3. Try a valuation: GET /api/v1/plates/BOB1 in Swagger UI

Useful Commands

make dev-stop     # Stop all services (keeps database)
make dev-restart  # Full restart
make dev-status   # Check health of all services
make dev-reset    # Reset database with seed data

Test Data

The seed database includes sample plates: BOB1, SAM1, 52O.

Sign up as your first test user through the Clerk UI in the nav bar.

For programmatic access in local dev, GET /api/v1/dev/info returns credentials.

Cloud Development (sst dev)

For the full developer experience with shareable URLs and Live proxy, see the Developer Setup guide to configure sst dev.

Next Steps