Installation

Prerequisites

Before you begin, make sure you have:

• Bun >= 1.3.8
• PostgreSQL database
• An OIDC provider (e.g., Keycloak, Auth0, Okta, Pocket ID)

Clone the Repository

git clone <repository-url>
cd quiz-app

Install Dependencies

bun install

Set Up Environment Variables

Create a .env.local file in the apps/web directory:

cp apps/web/.env.example apps/web/.env.local

Edit the .env.local file with your configuration. See Configuration for details.

Set Up the Database

Option 1: Using Docker Compose (Recommended)

Start PostgreSQL and Valkey using Docker Compose:

docker compose up -d

This starts:

• PostgreSQL on port 5432
• Valkey (Redis) on port 6379

Option 2: Local PostgreSQL

If you have PostgreSQL installed locally:

macOS (Homebrew):

brew install postgresql@16
brew services start postgresql@16
createdb quiz_app

Ubuntu/Debian:

sudo apt install postgresql postgresql-contrib
sudo systemctl start postgresql
sudo -u postgres createdb quiz_app

Run Migrations

After setting up PostgreSQL, run the database migrations:

bun run db:migrate

Start the Development Server

bun run dev

The app will be available at http://localhost:3000.

Next Steps

• Configure environment variables
• Set up authentication
• Configure RBAC permissions