§ 01 / Start
Quick start
$ npm create zn
Or pnpm, yarn, bun.
The installer asks what you’re building, picks relevant questions and skips everything that can’t change the answer. After a short conversation you have a running project with frontend, backend, and a complete development environment.
Run using "npm run dev", more at Quick start.
§ 02 / Guides
Guides
What a scaffolded project gives you and how to work with it, one page per topic.
- Quick startScaffold a zenness project and have both halves running in a minute.
- Project structureWhat each folder is for, in both halves of a scaffolded project.
- Development workflowHow the Astro and Nitro halves fit together in dev and production.
- ConfigurationThe example-file convention, the site URL, and every environment variable.
- API routesFile-based routes, validation, useEvent(), auto-imports and logging.
§ 03 / Scaffolding
What you can choose during scaffolding
Every category the installer steps through. The exact set depends on the parts you pick; the descriptions are the same text you’ll see in your terminal.
- Project location
- Where to scaffold
- Parts
- Frontend, backend, or both
- CSS framework
- Tailwind CSS, Bootstrap, shadcn/ui, Ant Design
- Processors
- Sass/SCSS, PostCSS, or neither
- UI components
- Bring your own components from React, Vue, Svelte, or none
- Development tools
- Prettier, Autoprefixer, Stylelint, Biome
- Deploy preset
- Vercel, Firebase, Cloudflare, Zephyr, manual
- Basic features
- Feed, SEO, search, accounts, media, forms
- Database
- None, SQLite or PostgreSQL
- Sitemap and site URL
- Generated, if you want them
A full walkthrough starts at Quick start.
