Express API Generator

🚀 Express API Generator is a powerful CLI tool that helps you quickly scaffold an Express.js API with built-in support for MongoDB, MySQL, or PostgreSQL. This tool ensures a well-structured Express project setup, including environment configuration, authentication, middleware, and dependency installation.

📦 Installation

Install the package globally:

1npm install -g express-api-kit

Or use it directly with npx:

1npx express-api-kit

🚀 Usage

To create a new Express API project, run:

1npx express-api-kit

If installed globally:

1express-api-kit

✨ Features

• 🔧 Auto-generates a structured Express API project
• 🗄️ Supports MongoDB, MySQL, and PostgreSQL
• ⚙️ Automatic .env file setup
• 📦 Installs dependencies automatically
• 🏗️ Pre-configured folder structure for scalability
• 🔐 Includes authentication, middleware, and service layers
• 🔄 Interactive CLI setup for easy customization
• 🎯 Designed for production-ready development

🛠 Interactive Setup

The CLI will prompt you for the following:

• Project Name (default: express-api-kit)
• Database Selection (MongoDB, MySQL, PostgreSQL)

Example:

1? Enter project name: my-api
2? Select database: MongoDB

📌 Project Structure

After running the generator, your project will have the following structure:

project-name/
│-- config/       # Configuration files (e.g., database connection)
│-- controllers/  # Business logic & request handling
│-- docs/         # API documentation files (Swagger/Postman)
│-- middlewares/  # Middleware functions (authentication, logging, etc.)
│-- models/       # Database models/schema (Mongoose for MongoDB, Sequelize for SQL)
│-- routes/       # Express route definitions
│-- services/     # Business logic and reusable functions
│-- utils/        # Utility/helper functions
│-- .env          # Environment variables
│-- app.js        # Express app setup & middleware configuration
│-- server.js     # Entry point - Starts the server
│-- package.json  # Project dependencies and scripts

📜 Environment Variables

A .env file is automatically generated with the following variables:

For MongoDB:

1PORT=5000
2MONGO_URI=mongodb://localhost:27017/my-api
3JWT_SECRET=your_jwt_secret
4EMAIL_USER=your_email
5EMAIL_PASS=your_password

For MySQL/PostgreSQL:

1PORT=5000
2DB_HOST=localhost
3DB_USER=root
4DB_PASS=password
5DB_NAME=my-api
6DB_DIALECT=your_database_dialect
7JWT_SECRET=your_jwt_secret
8EMAIL_USER=your_email
9EMAIL_PASS=your_password

🏃 Running the Project

After generation, move into the project directory and start the server:

1cd my-api
2npm start

💙 Support & Contribution

👨‍💻 Developed by: Muhammad Ahmad

📢 If you like this tool, give it a star ⭐ on GitHub!

Feel free to contribute by submitting issues and pull requests.

Happy Coding! 🎉