Skip to content

Project Scaffolding

Create new Nevr projects with create-nevr - a zero-config scaffolding tool.

Quick Start

bash
npm create nevr@latest

This launches an interactive wizard to configure your project.

Non-Interactive Mode

For CI/CD or scripting, use flags to skip prompts:

bash
npm create nevr@latest my-api --no-interactive

CLI Options

OptionAliasDescription
--template <name>-tFramework: express or hono
--database <db>-dDatabase: sqlite, postgresql, mysql
--authInclude auth plugin
--no-authSkip auth plugin
--pm <manager>-pPackage manager: npm, pnpm, bun
--no-installSkip dependency installation
--no-interactiveUse defaults, no prompts
--help-hShow help
--version-vShow version

Examples

Express with PostgreSQL and Auth

bash
npm create nevr@latest my-api -t express -d postgresql --auth

Hono with SQLite (minimal)

bash
npm create nevr@latest my-api -t hono -d sqlite --no-auth

Using pnpm, no install

bash
npm create nevr@latest my-api -p pnpm --no-install

Templates

Classic Node.js framework, battle-tested and widely adopted.

Generated structure:

my-api/
├── src/
│   ├── entities/
│   ├── hooks/
│   ├── routes/
│   ├── middleware/
│   ├── utils/
│   ├── nevr.config.ts
│   ├── generate.ts
│   └── server.ts
├── prisma/
├── package.json
├── tsconfig.json
└── .env

Hono

Ultrafast, lightweight, edge-ready framework.

Same structure as Express, but with Hono-specific server.ts.

Database Options

DatabaseConnection String
SQLitefile:./dev.db
PostgreSQLpostgresql://user:pass@localhost:5432/db
MySQLmysql://user:pass@localhost:3306/db

Auth Plugin

When --auth is enabled, the scaffolder adds:

  • src/plugins/auth.ts - Auth plugin configuration
  • src/plugins/index.ts - Plugin exports
  • Auth-related environment variables

After Scaffolding

bash
cd my-api
npm run generate     # Generate Prisma schema
npm run db:push      # Create database
npm run dev          # Start development server

Next Steps

Released under the MIT License.