A production-ready CLI to scaffold Express.js APIs in seconds
Skip the boilerplate. Start building. Choose your language. Pick your architecture.
--- ## β¨ Features | Feature | Description | |---------|-------------| | π· **TypeScript & JavaScript** | Full support for both languagesβyou choose | | ποΈ **MVC or Scalable Architecture** | Classic Model-View-Controller or modern modular structure | | π **MongoDB Ready** | Pre-configured MongoDB connection with Mongoose | | π **Smart Project Structure** | Organized folders for controllers, routes, models, and utilities | | π§ **ESLint + Prettier + Biome** | Code quality tools configured out of the box | | π¦ **Auto Dependency Install** | Optional automatic `npm install` during setup | | π― **Interactive CLI** | Guided prompts for a smooth setup experience | --- ## π¦ Quick Start ```bash npx express-api-template ``` That's it! The CLI will guide you through: 1. **Project name** β Name your project folder 2. **Architecture** β Choose MVC or Scalable (Modular) 3. **Language** β JavaScript or TypeScript 4. **Dependencies** β Auto-install packages or do it yourself --- ## ποΈ Project Structures ### MVC (Model-View-Controller) Traditional, battle-tested architecture ideal for small to medium projects. ``` my-project/ βββ config/ # Configuration files βββ controllers/ # Request handlers βββ models/ # Mongoose schemas βββ routers/ # Express routes βββ utils/ # Helper functions βββ lib/ # Shared libraries βββ index.js # Entry point βββ .env # Environment variables ``` ### Scalable (Modular) Feature-based architecture designed for large, maintainable codebases. ``` my-project/ βββ src/ β βββ modules/ # Feature modules (users, auth, etc.) β βββ common/ # Shared utilities β βββ config/ # App configuration β βββ index.ts # Entry point βββ tsconfig.json # TypeScript config (if applicable) βββ .env # Environment variables ``` --- ## π After Installation ```bash # Navigate to your project cd my-project # Set up environment variables cp .env.example .env # Edit with your config # Start development server npm run dev ``` --- ## π οΈ Included Tools | Tool | Purpose | |------|---------| | [ESLint](https://eslint.org/) | Linting and code standards | | [Prettier](https://prettier.io/) | Code formatting | | [Biome](https://biomejs.dev/) | Fast formatter & linter | | [Mongoose](https://mongoosejs.com/) | MongoDB object modeling | | [dotenv](https://github.com/motdotla/dotenv) | Environment variable management | --- ## π Available Scripts | Script | Description | |--------|-------------| | `npm run dev` | Start development server with hot reload | | `npm run start` | Start production server | | `npm run lint` | Run ESLint checks | | `npm run format` | Format code with Prettier/Biome | --- ## π€ Contributing Contributions are welcome! Feel free to: 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request --- ## π License This project is licensed under the **MIT License** β see the [LICENSE](LICENSE) file for details. ---Built with β€οΈ by Harshil
β Star this repo if you find it useful!