GEN-EXPRESS-CLI

📘 Introduction

[!NOTE] GEN-EXPRESS-CLI now supports express 5! You can use the latest version of express with this CLI tool.

gen-express-cli is a alternative to express-generator with more features and easy to use. It is a command line tool that helps you to generate a new express project with TypeScript, ESM, Docker, Prettier, ESLint, Jest, and Path Alias.

✨ Features

• 📦 ES Module
• 📦 TypeScript
• 📦 Prettier & ESLint
• 📦 Jest
• 📦 Path Alias
• 📦 Dockerfile

📂 Quick Start

1npx gen-express-cli@latest <project-name>

1cd <project-name>

1npm run dev # for development
2npm run start # for production
3npm run build # for typescript build
4npm run lint # for eslint
5npm run format # for prettier
6npm run test # for unit test
7
8docker build -t <image-name> .

📖 Usage

1npx gen-express-cli --help
2
3Usage: gen-express-cli [project-name]
4
5Options:
6  -v, --version                     output the current version
7  -t, --template <template-name>    choose express template (choices: "javascript", "typescript")
8  -l, --linter                      choose linter (default: false)
9  -u, --unit-test <unit-test-name>  choose unit test (choices: "jest", "none")
10  -d, --docker                      use docker for containerization (default: false)
11  -al, --alias                      use alias for import (default: false)
12  -m  --manager <package-manager>   choose package manager (choices: "npm", "yarn")
13  -h, --help                        display help for command

📂 Folder Structure

1├─ src
2│  ├─ index.ts
3│  ├─ __tests__
4│  │  └─ user.spec.ts
5│  ├─ controllers
6│  │  └─ user.ts
7│  ├─ models
8│  │  └─ user.ts
9│  └─ routes
10│     ├─ index.ts
11│     └─ user.ts
12├─ .dockerignore
13├─ .env
14├─ .env.development
15├─ .eslintrc.json
16├─ .gitignore
17├─ .prettierrc.json
18├─ Dockerfile
19├─ jest.config.ts
20├─ package-lock.json
21├─ package.json
22├─ process.env.d.ts
23├─ README.md
24└─ tsconfig.json

📦 Dependencies

Please see dependency.js for more details.

📚 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.