Skip to content
findplate

DocsStart

Quickstart

From zero to a running project in a few minutes.

On this page

Requirements

  • Node 24 or newer
  • pnpm for the generated project
  • Docker, for the local Postgres
  • bun, if you run the cli with bunx

Create a project

bunx findplate create

The prompts ask for a project name, a one-line pitch and a design preset, then offer a profile to start from. Every answer has a flag, see the CLI reference.

◆  Profile
│  ○ Minimal    (just the core, add modules later with findplate add)
│  ● Standard   (the usual starting set, nothing to host yourself)
│  ○ Everything (every module that runs without a server of your own)
│  ○ Custom     (start from standard and pick by hand)

●  Standard picks storage, docs, ai, rate-limit

◆  Modules (space toggles, enter confirms)
│  ◻ Product pages
│  │ ◼ Docs site
│  │ ◻ Waitlist
│  └ ◻ Status page
│  ◻ Platform
│  │ ◼ File storage
│  │ ◼ AI
│  └ ◼ Rate limiting
│  ◻ Notifications
│  └ ◻ Notification
│  ...

●  Notification needs Webhooks, added it

◇  Keys you will need ──────────────────────────────────────────────────╮
│  RESEND_API_KEY      Resend API key (email)                           │
│                      https://resend.com/api-keys                      │
│  GROQ_API_KEY        Groq API key  https://console.groq.com/keys      │
╰───────────────────────────────────────────────────────────────────────╯
◆  Resend API key (email) (optional, https://resend.com/api-keys)
│  _

Press Enter on any key to skip it. The skipped ones come back as a "Still to set in .env" list when the cli finishes, and findplate doctor keeps warning until they are filled. Skip the prompts with --profile or --modules, see modules.

The cli then copies the template, installs dependencies, formats the result with biome and makes the first git commit on main.

Run it

cd my-app
pnpm db:up
pnpm dev

pnpm db:up starts Postgres in docker, on the first free port from 5432. The dashboard admin email is printed when the cli finishes, and the password is ADMIN_PASSWORD in your .env.

Next steps