Templates
Blank Template
Start from an empty Nextly config and define your own schemas.
The Blank template scaffolds a minimal Nextly project with no collections or singles defined. You get the full Next.js App Router setup, the admin route, the standard environment configuration, and an empty nextly.config.ts ready for you to fill in. It's the starting point when you want to design your schema from scratch.
Scaffold
pnpm create nextly-app@alpha my-app --template blanknpx create-nextly-app@alpha my-app --template blankyarn create nextly-app@alpha my-app --template blankbun create nextly-app@alpha my-app --template blankWhat it ships
- Empty
nextly.config.tswithcollections: []andsingles: []. Add definitions here as you build. - Standard Next.js App Router setup -- root
layout.tsx,globals.css, afavicon.ico, and the home page at(frontend)/page.tsx. The landing page is a simple "Welcome" screen with a link into the admin. - Generated admin route at
src/app/admin/[[...params]]/. The page wires upRootLayout,QueryProviderandErrorBoundary, and imports@nextlyhq/admin/style.css. The layout reads admin branding fromnextly.config.tsand injects the resulting CSS variables. - Health and media routes under
src/app/api/, and the admin media library's route atsrc/app/admin/api/media/. - Default
next.config.tswhoseserverExternalPackageslists Nextly's server packages and the adapter and driver for the database you chose. See Project Structure for the full list and what each entry does. - Default
.env.examplewithDB_DIALECT,DATABASE_URL,NEXTLY_SECRETandNEXT_PUBLIC_APP_URL. Media is stored on local disk until you configure a storage adapter. AGENTS.mdandCLAUDE.mdwith instructions for coding agents working in the project.- Skills for coding agents in
.agents/skills/and.claude/skills/, unless you pass--no-skills, answer no, or the project installs a differentnextlyrelease than the skills were checked against. See Coding agents. - Generated
nextly-types.tsstub undersrc/types/generated/so type generation has a destination on first run.
File tree
my-app/
├── src/
│ ├── app/
│ │ ├── (frontend)/
│ │ │ ├── components/
│ │ │ └── page.tsx
│ │ ├── admin/
│ │ │ ├── [[...params]]/
│ │ │ │ ├── layout.tsx
│ │ │ │ └── page.tsx
│ │ │ └── api/
│ │ │ ├── [[...params]]/
│ │ │ │ └── route.ts
│ │ │ └── media/
│ │ │ └── [[...path]]/
│ │ │ └── route.ts
│ │ ├── api/
│ │ │ ├── health/
│ │ │ │ └── route.ts
│ │ │ └── media/
│ │ │ └── [[...path]]/
│ │ │ └── route.ts
│ │ ├── favicon.ico
│ │ ├── globals.css
│ │ └── layout.tsx
│ ├── lib/
│ │ └── site-url.ts
│ └── types/
│ └── generated/
│ └── nextly-types.ts
├── public/
├── .agents/skills/
├── .claude/skills/
├── .env
├── .env.example
├── AGENTS.md
├── CLAUDE.md
├── eslint.config.mjs
├── next.config.ts
├── nextly.config.ts
├── package.json
├── pnpm-workspace.yaml
├── postcss.config.mjs
└── tsconfig.jsonNext steps
- Installation -- Create your super-admin account on first run.
- Tutorial: build a blog -- Build something concrete (a blog with posts and categories) to learn the API.
- Configuration -- Define your first collections and singles in
nextly.config.ts.