Getting Started

0. Make it your own project

pnpm run init

The script asks for a site name, short name, domain, and support email, then:

• replaces the brand name across messages, manifest, package.json, and wrangler.jsonc;
• resets content module switches to your choices (all off by default; use

--modules docs,blog to enable them);

• generates .env from .env.example and fills in empty keys such as BETTER_AUTH_SECRET.

Pressing Enter through every prompt gives you a runnable project. --non-interactive is for scripted setups, and --dry-run prints the files that would change. Re-running is safe: existing .env values and brand names are not rewritten.

Modules default to off on purpose. The template ships with mail, analytics, and others enabled, and each of them requires its own credentials — a fresh clone would otherwise fail production validation immediately. Turn on what you need.

1. Install dependencies

pnpm install

2. Provision local resources

pnpm run setup

The script asks for a project name, then creates (or reuses) a D1 database and a KV namespace, generates the auth secret, and writes the results to .env and wrangler.jsonc. Existing .env values are kept — only the keys the script manages are rewritten.

R2 is not created for you: the bucket must be activated once in the Cloudflare dashboard (it requires a payment method, so the API cannot do it). See Storage for the manual steps.

If you are not logged in to Cloudflare it warns you but continues — local development uses a SQLite-backed D1 and needs no real resources. To log in:

pnpm exec wrangler login

3. Start the dev server

pnpm dev

Open http://localhost:3000. If the database was not initialized, run it manually:

pnpm exec wrangler d1 migrations apply DB --local

4. Customize the site

All site identity lives in src/config/website.ts:

// src/config/website.ts
export function createWebsiteConfig(env: PublicEnv): WebsiteConfig {
  return {
    baseUrl: env.VITE_BASE_URL,
    metadata: {
      name: '<your-site-name>',                // ← your site name
      images: { ogImage: '/logo.png', /* … */ },
    },
    docs: { enabled: true },                 // ← set false to drop the docs site
    // …
  }
}

See Website Config for every field.

5. Deploy

pnpm deploy

This runs production env validation → build → client bundle leak check → wrangler deploy.

Local .env values do not become production secrets. Configure them separately with wrangler secret put, and never put a secret behind a VITE_ prefix — those are inlined into the browser bundle.

To deploy automatically on push to main, see Cloudflare · CI deployment.