Skip to content

Quick Start

OpenQuok quick start — install dependencies, configure env, and run the social scheduler locally.

1 min read

Prerequisites

  • Node.js 24.x or higher
  • Corepack — enables the pinned pnpm version and avoids Node’s url.parse deprecation during installs. 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

  1. Clone this repository.

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

pnpm install
  1. 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/

Development environment

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

Next steps

Explore the architecture, installation, contributor guidelines, and how to author this documentation site:

Project architecture
Monorepo layout, key directories, and how the stack fits together
Installation
Development environment, deployment on Vercel, and related setup guides
Developer guidelines
Conventions and practices for working in this repository
How to write docs
Configure, write, and extend the documentation area in web/