GEN-EXPRESS-CLI

📘 Introduction

gen-express-cli is a powerful and modern alternative to the default express-generator, designed to help you build structured, scalable, and production-ready Express applications—fast.

With just a single command, it scaffolds a clean, opinionated project layout powered by TypeScript, ESM, testing, validation, environment configs, and more. Whether you're building a quick prototype or a maintainable backend for a real-world product, gen-express-cli provides everything you need to get started—without the boilerplate.

Forget the chaos of manually setting up tools and project structure. This CLI gives you best practices out of the box, while keeping the flexibility and simplicity of Express.

✨ Features

• 📦 Full ESM Support (TypeScript module: NodeNext)
• 📂 Organized Folder Structure (controllers, services, routes, middlewares, etc.)
• 🧠 TypeScript with ready‑to‑use build scripts
• 🧰 ESLint v9 (Flat Config) & Prettier preconfigured
• 🧪 Unit Testing with Jest (ESM‑ready setup)
• 🛣️ Path Aliases (#src/) with runtime resolution
• 🐳 Dockerfile for production builds
• ⚙️ Environment Config Setup
• ✅ Request Validation (with zod)
• 🧾 Logger (with winston) & Error Handling
• ⚙️ CI Templates (with GitHub Actions format/lint/test)

📂 Quick Start

# Default (TypeScript)
npx gen-express-cli@latest <project-name>

# For JavaScript
npx gen-express-cli@latest <project-name> -t javascript

npm run dev           # for development
npm run start         # for production
npm run build         # for typescript build
npm run lint          # for eslint
npm run lint:fix      # for eslint fix
npm run format        # for prettier
npm run format:check  # for prettier check
npm run typecheck     # for typescript type check
npm run test          # for unit test
npm run test:watch    # for unit test in watch mode
npm run test:cov      # for test coverage

docker build -t my-express-app:1.0 .
docker run -p 8000:8000 --env-file ./.env my-express-app:1.0 

📂 Folder Structure

ts
├─ .dockerignore
├─ .nvmrc
├─ .prettierignore
├─ .prettierrc.json
├─ Dockerfile
├─ eslint.config.js
├─ jest.config.ts
├─ package-lock.json
├─ package.json
├─ README.md
├─ src
│  ├─ app.ts
│  ├─ config
│  │  └─ env.ts
│  ├─ middlewares
│  │  ├─ error-handler.ts
│  │  ├─ index.ts
│  │  ├─ logger.ts
│  │  └─ validate.ts
│  ├─ modules
│  │  ├─ healthcheck
│  │  │  ├─ healthcheck.controller.ts
│  │  │  └─ healthcheck.route.ts
│  │  └─ user
│  │     ├─ user.controller.ts
│  │     ├─ user.route.ts
│  │     ├─ user.schema.ts
│  │     ├─ user.service.test.ts
│  │     ├─ user.service.ts
│  │     └─ user.types.ts
│  └─ server.ts
├─ tsconfig.build.json
└─ tsconfig.json

📚 License

This project is licensed under the terms of the MIT license.

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to give your feedback and give me a star if you like this project.