avedon

Quick start

Create a new avedon app, run it locally, and produce a production build.

Prerequisites

  • Node.js >= 20
  • A package manager: pnpm (recommended), npm, or yarn

Create an app

pnpm create avedon-app my-app
cd my-app
pnpm install
pnpm dev

Equivalents:

npm create avedon-app@latest my-app
# or
npx create-avedon-app my-app
# or
avedon create my-app

Open http://localhost:5173. The scaffold ships a home page at /.

Scaffold options

On a TTY the CLI can prompt for Tailwind and ORM. Flags skip prompts:

Flag Effect
--yes / -y Skip prompts (defaults: no Tailwind, no ORM)
--tailwind / --no-tailwind Convert starter styles to Tailwind v4 (PostCSS)
--orm=none|drizzle|prisma Wire ORM deps and config stubs (no schema models)
pnpm create avedon-app my-app --tailwind --orm=drizzle
pnpm create avedon-app my-app --yes

Everyday commands

From your app directory:

Script Command Purpose
dev avedon dev Vite dev server + SSR middleware
build avedon build Client + server bundles and SSG pages
start avedon start Run the Node production server
preview avedon preview Alias of start
pnpm build
pnpm start

Next steps

  1. Skim project structure
  2. Follow the tutorial to add a route with data and a form
  3. Read .ave components and routing