Getting Started

This is a starter page for your VitePress documentation.

Local Development

Install dependencies:

npm install

Start the docs server:

npm run docs:dev

Build the static site:

npm run docs:build

Docker

Copy the example environment file:

cp .env.example .env

Generate secure local secrets and set them in .env:

openssl rand -base64 24
openssl rand -base64 48

Use the generated values for:

• POSTGRES_PASSWORD
• JWT_SECRET_KEY (minimum 32 chars)

Then make sure DATABASE_URL uses the same database password as POSTGRES_PASSWORD.

Start the full stack with Traefik:

docker compose up --build

The Compose stack includes PostgreSQL for the backend. Database data is stored in the postgres-data Docker volume. Backend database migrations are managed with Alembic and run automatically when the backend container starts.

The default local routes are:

• Docs: http://docs.localhost
• Frontend: http://app.localhost
• API: http://api.localhost
• Traefik dashboard: http://traefik.localhost

The frontend supports user sign up, sign in, sign out, and user management through the API. The API uses OAuth2 password bearer tokens and accepts either username or email in the sign in form.