Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Setup

For ScottyLabs Org Member setup instructions, see CONTRIBUTING.md.

Prerequisites

Install Lix and log in to OpenBao by following kennel’s local development and secrets guides.

Initial Setup

cd housing
nix develop

Running the app

Start PostgreSQL, the Ricochet login relay, the backend on port 3001, and the frontend from the repo root:

pitchfork start --local

The backend is proxied through the Vite development server and can be accessed at http://localhost:3000 during development. The backend should not be accessed directly, as all paths prefixed with /api will be routed to the backend.

Deployment

Kennel deploys the backend service in flake.nix, which also serves the built frontend, at https://cmuhousing.com.