Getting Started

Prerequisites

• A recent Node.js LTS release.
• pnpm 10 or newer.
• A Cloudflare account if you want to provision and deploy the platform.
• A Telegram bot token if you want to test the Telegram path.

Install

pnpm install
cp .env.example .env
cp apps/api/.dev.vars.example apps/api/.dev.vars
cp apps/runtime/.dev.vars.example apps/runtime/.dev.vars
cp apps/admin/.env.example apps/admin/.env.local

Run locally

pnpm check
pnpm dev:api
pnpm dev:admin

If you want to browse these docs locally:

pnpm docs:dev

First Cloudflare setup

Provision resources, apply migrations, and deploy the app slices:

pnpm cf:provision
pnpm cf:migrate
pnpm cf:deploy

The repo also supports environment-specific commands:

pnpm cf:provision:staging
pnpm cf:migrate:staging
pnpm cf:deploy:staging
pnpm cf:deploy:runtime:staging

Telegram test path

After Cloudflare resources and migrations are ready:

pnpm telegram:seed:staging
pnpm telegram:webhook:staging
pnpm cf:deploy:staging
pnpm telegram:smoke:staging

Then send /start, /help, /status, /run hello, or a normal text message in the bound Telegram chat.

Recommended order

1. Install dependencies.
2. Configure local env files.
3. Run pnpm check.
4. Provision Cloudflare resources.
5. Apply D1 migrations.
6. Deploy the Workers and admin site.
7. Register the Telegram webhook if you need messaging.