Quick Start

Quick start — install dependencies, configure env, and run the OpenQuok's social scheduler locally.

2 min read

Connect your agent today

Draft from chat, review in your calendar, and publish only what you approve.

Prerequisites

Node.js 24.x or higher
Corepack — enables the pinned pnpm version. Run corepack enable. The repo pins pnpm via the root packageManager field (e.g. pnpm@10.30.3) so installs stay consistent and avoid mixed-tooling issues.
A Supabase account (for backend / local development against the project)

nvm use 24.14.0
corepack enable

Quickstart

Clone this repository.
Install dependencies — use pnpm only; npm/yarn are blocked in this repo to avoid mixed installs:

pnpm install

Set up environment variables — follow the configuration guides for each package:

Backend configuration

Env files and variables for the backend / Supabase workspace

Frontend configuration

Environment variables for the SvelteKit app in web/

Self-host with Docker Compose

Operators who want API, web, Redis, and workers in containers (not the contributor pnpm path) should follow Docker Compose. After docker compose -f infra/self-host/docker-compose.yml up —build, open http://localhost:4007.

Docker Compose (self-host)

Bring the stack up

System requirements

CPU, RAM, ports, and operator-provided Supabase

Development and Production environments

Commands for running backend/ and web/, tests, database scripts, and deployment live on the Development environment page so this quick start stays focused on first-time setup.

Development environment

Local dev servers, tests, DB tasks, and deployment commands

Production environment

Deploy on production

Orchestrator workers (BullMQ) and cleanup

For BullMQ-backed workflows, run the worker processes from orchestrator/. The orchestrator guide covers commands, the Redis cleanup script, and what to do when Flowcraft run state in Redis is stale.

Backend orchestrator workflows

BullMQ transport, workers, and clearing stale Flowcraft runs in Redis

Configuration - Worker

Env, Railway deploy notes, and worker-related scripts

CLI auth server (device flow)

For CLI device-flow login, run the auth server from agent/server/. The agent configuration guide covers env vars, the API / browser origin split, Postgres (including Neon), and Vercel deploy notes.

Configuration - Agent

CLI auth server secrets, BROWSER_ORIGIN, and production OAuth callbacks

Auth server architecture

Split topology, endpoints, and Postgres device-flow state