Skip to Content
DevelopersGetting Started

Getting Started

Prerequisites

Node.js 22 or later

Installation

npx create-oberon-app my-app

Answer the prompts:

  • App name - Valid npm package name for the starter app
  • Package manager - npm, pnpm, or yarn
  • Recipe - Starter app recipe (currently nextjs)
  • Database - Turso, PostgreSQL, or custom
  • Email service - Resend, SendGrid, or custom
  • Admin email - Initial account email

The installer then:

  • Scaffolds a starter app from the selected recipe into your target directory
  • Generates oberon/adapter.ts from selected plugins
  • Creates .env.local with the provided admin email
  • Installs dependencies and runs recipe prebuild

Run

cd my-app
pnpm dev

Open http://localhost:3000/cms for the editor.

Options

Pre-fill prompts with flags:

npx create-oberon-app my-app --use pnpm --recipe nextjs --database turso --send resend --email admin@example.com

Use --dir <directory> to scaffold into a directory different from the starter app name.

See Also

  • Configuration - Oberon runtime composition and runtime config
  • Plugins - Database and email adapters
Last updated on
IntroductionConfiguration