Getting started
Requirements
Use Node.js 24.21.0 or later. The installer supports npm, pnpm, and Yarn.
Create an app
Run the installer:
npx create-oberon-app my-appSelect these options:
- App name: A valid npm package name
- Package manager: npm, pnpm, or Yarn
- Recipe:
nextjsortanstack - Database:
turso,pgsql, orcustom - Email service:
resend,sendgrid, orcustom - Admin email: The initial admin address
The installer copies the recipe, writes the config, and creates .env.local. It installs
dependencies, formats the app, and runs bootstrap. Custom database and email templates need your
implementation.
Start the app
Open the app directory:
cd my-appStart the development server with your selected package manager:
npm run devOpen the URL shown in the terminal. Add /cms to that URL to open the editor. The development email
plugin writes sign-in codes to the terminal.
Command options
Use flags to supply answers:
npx create-oberon-app my-app --use pnpm --recipe nextjs --database turso --send resend --email admin@example.comUse --dir <directory> for a target directory that differs from the app name.
See Configuration before you change plugins. See Deployment before you publish the app.
Last updated on