Skip to content

README.md

Latest commit

 

History

History
91 lines (66 loc) · 1.5 KB

README.md

File metadata and controls

91 lines (66 loc) · 1.5 KB

create-express-pro

Scaffold a production-ready Express.js backend in seconds.

License Node

✨ Features

  • ✅ Express.js starter template
  • ✅ Modular folder structure
  • ✅ Middleware setup (Helmet, CORS, Compression, Morgan)
  • ✅ Logging with Winston (optionally with log files)
  • ✅ Rate limiter and Multer config (optional)
  • ✅ Prettier formatting
  • ✅ Socket.IO support
  • ✅ Environment-ready .env file
  • ✅ Interactive CLI powered by inquirer

📦 Installation

npm install -g create-express-pro

🚀 Usage

create-express-pro

The CLI will prompt you for:

  • Project name
  • Author name
  • Port number
  • JavaScript or TypeScript
  • Use of Winston log files
  • Package manager (npm, yarn, pnpm)

📁 Folder Structure

your-project/
├── controllers/
├── db/
├── logs/
├── middlewares/
├── models/
├── routes/
├── utils/
├── views/
├── uploads/
├── public/
├── app.js
├── .env
├── .gitignore
└── package.json

💠 Scripts

Each generated project comes with:

"scripts": {
  "dev": "nodemon app.js",
  "start": "node app.js",
  "format": "prettier --write ."
}

✉ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

👉 License

MIT