Skip to content
VegaStack
All docs
Start

Quickstart

Stand VegaStack up in five minutes and share your first page.

Updated 2026-05-24

Quickstart

This is the shortest possible path from cloning the repo to opening a public link in a browser.

Prerequisites

You will need a recent Node.js, pnpm, and a Cloudflare account (for the managed runtime). Nothing else is required for the local walk-through below.

Local install

git clone https://example.com/vegastack.git
cd vegastack
pnpm install
pnpm dev

That's it. pnpm dev runs a predev bootstrap that:

  1. Creates apps/web/.env.local from apps/web/.env.example if it's missing.
  2. Applies any pending DB migrations to the local Postgres database.
  3. Seeds a default admin (dev@vegastack.local) + a "VegaStack" workspace + a "My Space" space if none exists.

The dev server listens on http://127.0.0.1:3000.

Signing in

On /login, click Dev login. You land on the dashboard for the default workspace. No setup form, no setup token, no email needed in dev mode.

The dev-login button is only shown when VEGASTACK_DEPLOYMENT_MODE=development and VEGASTACK_EMAIL_PROVIDER=none|console — both set by .env.example. In production it's hidden and never functional.

Keeping up to date

Pull the latest from main and run pnpm dev again — the predev hook re-runs migrations against your dev DB before next dev starts. Your existing pages, comments, and settings survive every migration we ship (we treat the dev DB the same as production data: additive ALTERs, copy-and-rename for any restructure).

If you ever want to start over: pnpm db:reset wipes apps/web/.vegastack/ and re-bootstraps.

Without starting the server

pnpm db:migrate             # apply pending migrations only (no server)
pnpm db:reset               # wipe local data + re-bootstrap
pnpm preview                # build with OpenNext + serve under wrangler (prod-parity)

Write your first page

Click New in the sidebar, choose New page, give it a title, and save. The editor saves source on every change and snapshots a version on demand.

Open the page actions menu and choose Share. Turn on the Anyone with the link public link and set it to View or Comment, optionally add an expiry or password, then copy the public URL. The page is served live — rendered server-side and cached by content hash for fast public reads, refreshing automatically whenever you save.

Next steps