Node Backend Generator 🚀

A powerful CLI tool to generate professional, production-ready Node.js backend templates in seconds.
Choose your database, features, and get a complete backend with industry best practices.

✨ Features

• 🚀 Multiple Databases – MongoDB (Mongoose), MySQL/PostgreSQL (Sequelize), Prisma, or Database-less
• 🔐 Authentication – JWT with refresh tokens, bcrypt password hashing
• 📁 File Upload – Multer with validation & multiple file support
• 📧 Email Service – Nodemailer with ready templates (welcome, password reset, notifications)
• 📚 API Documentation – Auto-generated Swagger/OpenAPI docs
• 🐳 Docker Support – Dockerfile + docker-compose with database setup
• 🛡️ Security – Helmet, CORS, rate limiting, input validation
• ⚡ Modern JS – ES Modules & CommonJS support
• 🎯 Production Ready – Error handling, logging, environment config

🚀 Quick Start

Using npx (Recommended — No Installation Needed)

npx node-backend-generator@latest

Global Installation

npm install -g node-backend-generator

create-node-backend

Local Installation

npm install node-backend-generator
npx create-node-backend

🧭 Usage

1️⃣ Run the Generator

npx node-backend-generator@latest

2️⃣ Follow the Interactive Prompts

You’ll be guided through setting up your project:

Enter your project name: my-awesome-api

Example Interactive Setup:

? Enter your project name: my-awesome-api
? Choose module system:
❯ ES Modules (MJS)
  CommonJS (CJS)

? Choose database ORM:
❯ Mongoose (MongoDB)
  Sequelize (MySQL/PostgreSQL)
  Prisma (Multi-database)
  None (API only)

? Select additional features:
◉ Authentication (JWT)
◉ API Documentation (Swagger)
◯ File Upload (Multer)
◯ Email Service (Nodemailer)
◯ Docker Support
◉ Rate Limiting
◉ Input Validation

3️⃣ Generated Project Structure

my-awesome-api/
├── server.js
├── package.json
├── .env
├── .env.example
├── .gitignore
├── Dockerfile
├── docker-compose.yml
├── src/
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── middlewares/
│   ├── services/
│   └── utils/
├── uploads/
└── tests/

4️⃣ Get Started with Your New Project

cd my-awesome-api
npm install
cp .env.example .env

# Prisma only
npx prisma generate
npx prisma db push

# Start development server
npm run dev

# Or production
npm start

🎯 Available Scripts

npm start          # Start production server
npm run dev        # Start development server with nodemon
npm test           # Run tests
npm run lint       # Lint code
npm run lint:fix   # Auto-fix lint issues

📚 API Endpoints

🔐 Authentication (if enabled)

POST /api/auth/register      # Register user
POST /api/auth/login         # Login user
GET  /api/auth/profile       # Get logged-in profile

👤 User Routes

GET /api/users
GET /api/users/:id

📁 File Upload (if enabled)

POST /api/upload/single
POST /api/upload/multiple

📧 Email Service (if enabled)

POST /api/email/test
POST /api/email/password-reset
POST /api/email/welcome

🧰 Utilities

GET /health
GET /api-docs

🔧 Configuration

Environment Variables (.env)

# Server
NODE_ENV=development
PORT=3000

# Database
MONGODB_URI=mongodb://localhost:27017/your-db
# OR
DATABASE_URL="mysql://root:password@localhost:3306/your-db"

# JWT
JWT_SECRET=your_super_secret_key
JWT_EXPIRES_IN=7d

# Email
SMTP_HOST=your-smtp-host
SMTP_PORT=587
[email protected]
SMTP_PASS=your-password

🗄️ Database Setup

MongoDB (Mongoose)

1. Install MongoDB or use Atlas.
2. Update MONGODB_URI in .env.
3. Done! No schema migration needed.

MySQL / PostgreSQL (Sequelize)

1. Install the respective DB.
2. Create your database.
3. Update .env credentials.

Prisma

npx prisma generate
npx prisma db push

🐳 Docker Support

If you selected Docker:

docker-compose up -d        # Start DB & app
docker build -t my-backend .
docker run -p 3000:3000 my-backend

🔐 Authentication Usage

Register a User

POST /api/auth/register
{
  "name": "John Doe",
  "email": "[email protected]",
  "password": "securepassword"
}

Login

POST /api/auth/login
{
  "email": "[email protected]",
  "password": "securepassword"
}

Protected Routes

Include JWT token in headers:

Authorization: Bearer <your_jwt_token_here>

📁 File Upload Example

const formData = new FormData();
formData.append('file', fileInput.files[0]);

fetch('/api/upload/single', {
  method: 'POST',
  headers: { Authorization: 'Bearer your-token' },
  body: formData,
});

📧 Email Service Example

Send Test Email

POST /api/email/test
{
  "email": "[email protected]"
}

Request Password Reset

POST /api/email/password-reset
{
  "email": "[email protected]"
}

🛠️ Customization

Add a New Route

• Create a controller in src/controllers/
• Add a route in src/routes/
• Import it in server.js

Add a New Model

• Add a model in src/models/
• Use it in your controller logic

Add Middleware

• Create in src/middlewares/
• Register globally or per-route in server.js

🤝 Support

• 📘 Docs: Visit /api-docs after starting your server
• 🐞 Issues: GitHub Issues
• 💬 FAQ: See in docs or discussions

📄 License

MIT License — see LICENSE for details.

🙏 Contributing

We welcome contributions!
Please read our Contributing Guide before submitting PRs.

✨ Happy Coding! ✨
Generated with ❤️ by Trina Dasgupta