breeze-init
v1.0.0
Published
Initialize a new Express.js API project in a Breeze!
Downloads
103
Readme
Breeze Init
CLI tool to scaffold a modern, production-ready Express.js API in a breeze.
Breeze Init can generate a project with the following features:
- Express.js + ES modules
- Optional Prisma + PostgreSQL
- Optional JWT authentication
- Optional Docker setup
- Optional ESLint + Prettier
- Optional Vitest tests
- Optional Swagger/OpenAPI docs
- Optional Git initialization
Installation
# pnpm
pnpm add -g breeze-init
# or npm
npm install -g breeze-initUsage
breeze-init <project-name> [options]Options
| Flag | Description |
|------------|-----------------------------------------------------------------------------|
| --auth | Adds JWT authentication with user registration, login, /me, and /status routes. |
| --db | Adds Prisma + PostgreSQL client, DATABASE_URL in .env.example, and Prisma scripts. |
| --docker | Adds a Dockerfile and basic Docker setup for containerizing the API. |
| --lint | Adds ESLint + Prettier configuration and lint / lint:fix / format scripts. |
| --test | Adds Vitest, a sample test file, and a test script. |
| --docs | Adds Swagger/OpenAPI support, swagger.js config, and /api/docs route. |
| --no-git | Skips git init and the initial commit in the generated project. |
Note: If you use
--authwithout--db, Breeze Init automatically enables--db.
