Build background jobs with JobOrc

Local setup

Run the full stack on your machine: PostgreSQL, Redis, MinIO, API (:8080), platform worker, and dashboard (:3000).

Prerequisites

• Node.js 20+
• pnpm 9.15+ (repo packageManager)
• Docker + Compose v2

Bring up Compose

1234567
git clone <repo> JobOrc && cd JobOrc
cp .env.example .env
# From repo root (includes infra/compose/docker-compose.yml)
docker compose up -d --build
curl -sf http://localhost:8080/healthz && echo OK

If you started Compose from infra/compose/, use that directory (or -p compose) when running docker compose ps — project name follows the folder.

Migrations

12
pnpm install
pnpm --filter @joborc/db-migrations migrate:up

Create credentials

1. Open http://localhost:3000
2. Sign up → create organization + project
3. Create an API key
4. Export JOBORC_BASE_URL, JOBORC_API_KEY, JOBORC_PROJECT_ID

Hybrid mode

Data services in Docker; apps on the host:

1234
docker compose up -d postgres redis minio
pnpm --filter @joborc/api dev
pnpm --filter @joborc/worker dev
pnpm --filter @joborc/dashboard dev

Services

• API — http://localhost:8080
• Dashboard — http://localhost:3000
• MinIO console — http://localhost:9001

Next: Quickstart