Skip to content

RulerChen/gen-express-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GEN-EXPRESS-CLI

logo
GitHub License NPM Version node-current GitHub last commit NPM Downloads GitHub Repo stars

✨ Features

  • 📦 Easy to use
  • 📦 TypeScript Support
  • 📦 ESM Support
  • 📦 Prettier & ESLint Support
  • 📦 Jest Support (Unit Test)
  • 📦 SuperTest Support (E2E Test)

📂 Quick Start

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

cd <project-name>

npm run lint # for lint
npm run dev # for development
npm run build # for typescript build
npm run start # for production
npm run test # for unit test
npm run test:e2e # for e2e test

📖 Usage

Usage

npx gen-express-cli --help

Usage: gen-express-cli [project-name]

Options:
  -v, --version                     output the current version
  -t, --template <template-name>    choose express template (choices: "javascript", "typescript")
  -l, --linter <linter-name>        choose linter (choices: "eslint", "none")
  -u, --unit-test <unit-test-name>  choose unit test (choices: "jest", "none")
  -e, --e2e-test <e2e-test-name>    choose e2e test (choices: "supertest", "none")
  -h, --help                        display help for command

📂 Folder Structure

├─ src
│  ├─ index.ts
│  ├─ __tests__
│  │  └─ user.spec.ts
│  ├─ e2e
│  │  └─ user.spec.ts
│  ├─ controllers
│  │  └─ user.ts
│  ├─ models
│  │  └─ user.ts
│  └─ routes
│     ├─ index.ts
│     └─ user.ts
├─ .eslintrc.json
├─ .gitignore
├─ .prettierrc.json
├─ jest.config.ts
├─ package-lock.json
├─ package.json
├─ README.md
└─ 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.