Quick Start

Get up and running with Bedest in minutes.

1. Installation

Clone the repository and install dependencies using Bun.

bun install
cp .env.example .env

2. Database Setup

Spin up a local PostgreSQL instance via Docker:

docker run -d \
  --name postgres \
  -p 5432:5432 \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_DB=postgres \
  postgres:16-alpine

Execute the full database setup (resets, generates, migrates, and seeds):

bun run dev:setup

3. Development

Start the development server with hot-reload enabled:

bun run dev

Access the Swagger documentation at: http://localhost:3000/api/docs

4. Testing

Bedest uses PGlite for lightning-fast, isolated database tests. Tests run against an in-memory instance, allowing for safe mutations and instant feedback without requiring a running Docker container.

bun run test