backend-scaffold-cli 1.5.0 → 1.6.0

package/README.md

@@ -1,6 +1,7 @@
+
 # backend-scaffold-cli
 
-A CLI tool to quickly scaffold Express.js backend projects with MongoDB, middleware, and common setup. It automatically generates production-ready projects with JWT authentication, error handling, request logging, input validation, DNS configuration, and pre-configured MongoDB Atlas connection. Perfect for developers who want to skip boilerplate and start coding immediately.
+A CLI tool to quickly scaffold Express.js backend projects with MongoDB, middleware, and common setup. It automatically generates production-ready projects with JWT authentication, error handling, request logging, input validation, DNS configuration, and pre-configured MongoDB Atlas connection. Every project has different requirements, so this tool provides a solid, common foundation that developers can easily modify, extend, or trim according to their specific needs.
 
 ## Features
 
@@ -13,13 +14,17 @@ A CLI tool to quickly scaffold Express.js backend projects with MongoDB, middlew
 
 🔐 **Security**
 - JWT authentication middleware
+- Password hashing with bcryptjs
 - Error handling middleware
 - CORS configuration
+- Rate limiting (optional)
 
 📝 **Developer Experience**
 - Logging middleware
-- Input validation
-- Sample routes
+- Input validation (optional)
+- File upload support with multer (optional)
+- Axios utility for external API calls (optional)
+- Sample routes and User model
 - Git initialization
 - Auto dependency installation
 
@@ -38,55 +43,92 @@ npm install -g backend-scaffold-cli
 create-express-backend my-app
 ```
 
+> **Tip:** Always use `@latest` to ensure you get the newest version with all features and bug fixes.
+
 ## Usage
 
 ```bash
-npx backend-scaffold-cli <project-name>
+npx backend-scaffold-cli@latest <project-name>
 ```
 
 You'll be prompted to select features:
-- ✅ Include JWT authentication
-- ✅ Include logging middleware
+- ✅ Include JWT authentication (adds bcryptjs + User model)
 - ✅ Include input validation
+- ✅ Include rate limiting
+- ✅ Include file upload support (multer)
+- ✅ Include axios (for external API calls)
 - ✅ Install dependencies
 
+After setup, copy `.env.example` to `.env`, configure your MongoDB URI, then run:
+
+```bash
+npm start
+```
+
+Test it's working:
+```bash
+curl http://localhost:5000/api/health
+```
+
 ## Project Structure
+
 ```
 my-app/
 ├── src/
-│ ├── server.js
-│ ├── config/db.js
-│ ├── middleware/
-│ ├── routes/
-│ ├── controllers/
-│ ├── models/
-│ └── utils/
+│   ├── config/
+│   │   └── db.js
+│   ├── middleware/
+│   │   ├── errorHandler.js
+│   │   ├── logger.js
+│   │   ├── auth.js
+│   │   ├── validation.js
+│   │   ├── rateLimiter.js
+│   │   └── upload.js
+│   ├── routes/
+│   │   └── index.js
+│   ├── controllers/
+│   ├── models/
+│   │   └── User.js
+│   ├── utils/
+│   │   └── axiosUtil.js
+│   ├── validation/
+│   └── server.js
+├── uploads/
 ├── .env.example
 ├── .gitignore
 └── package.json
-```
-
-## Quick Start
 
-```bash
-npx backend-scaffold-cli my-app
-cd my-app
-cp .env.example .env
-npm start
 ```
 
-Visit: `http://localhost:5000/api/health`
 
 ## Environment Variables
 
 ```env
+# Server Configuration
 PORT=5000
 NODE_ENV=development
+
+# MongoDB Configuration
 MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/dbname
-JWT_SECRET=your-secret-key
+DB_NAME=myapp
+
+# DNS Configuration
 DNS_SERVERS=8.8.8.8,8.8.4.4
+
+# JWT Configuration
+JWT_SECRET=your-secret-key-change-this-in-production
+JWT_EXPIRE=7d
+
+# CORS
+CORS_ORIGIN=http://localhost:3000
 ```
 
+
+
 ## License
 
-MIT
+MIT
+
+## Repository
+
+https://github.com/abhi-0605/express-backend

package/bin/cli.js

@@ -7,8 +7,9 @@ const inquirer = require('inquirer');
 const fs = require('fs-extra');
 const path = require('path');
 const { execSync } = require('child_process');
+const packageJson = require('../package.json');
 
-const version = '1.0.0';
+const version = packageJson.version;
 
 program
   .version(version)
@@ -82,6 +83,7 @@ program
       }
       if(answers.useAxios){
         createAxiosUtil(projectPath);
+        createAuthController(projectPath);
       }
 
       console.log(chalk.cyan(' Initializing git repository...'));
@@ -464,6 +466,7 @@ const createRouteFiles = (projectPath, answers) => {
   const routes = `const express = require('express');
 const router = express.Router();
 ${answers.useAuth ? "const authenticateToken = require('../middleware/auth');" : ''}
+${answers.useAuth ? "const {register,login} = require('../controllers/authController');" : ''}
 ${answers.useFileUpload ? "const upload = require('../middleware/upload');" : ''}
 
 // Public routes
@@ -471,6 +474,13 @@ router.get('/health', (req, res) => {
   res.json({ status: 'API is running' });
 });
 
+${answers.useAuth? `
+  // Auth routes
+  // Register and Login routes
+  router.post('/auth/register', register);
+  router.post('/auth/login', login);
+` : ''}
+
 ${answers.useAuth ? `
 // Protected routes
 router.get('/protected', authenticateToken, (req, res) => {
@@ -679,6 +689,101 @@ function createUserModel(projectPath) {
 
 
 
+function createAuthController(projectPath) {
+  const authController = `const jwt= require('jsonwebtoken');
+  const User=require('../models/User');
+  const { ErrorHandler } = require('../middleware/errorHandler');
+
+  //generate JWT token
+  const generateToken = (userId) => {
+    return jwt.sign({ id: userId }, process.env.JWT_SECRET, {
+      expiresIn: process.env.JWT_EXPIRE || '7d'
+    });
+  };
+  
+
+  //register user
+  const register= async(req,res,next) =>{
+    try{
+      const {name,email,password}=req.body;
+
+      const existingUser= await User.findOne({email});
+      if(existingUser){
+        return next(new ErrorHandler('Email already Registered',400));
+      }
+
+      const user= await User.create({name,email,password});
+      const tocken= generateToken(user._id);
+
+      res.status(201).json({
+        success:true,
+        message:'User registered successfully',
+        token,
+        user:{
+          id:user._id,
+          name:user.name,
+          email:user.email
+        }
+      });
+    }catch(error){
+      next(error);
+    }
+  };
+
+
+
+  //login user
+  const login =async(req,res,next) =>{
+    try{
+      const {email,password}=req.body;
+
+      const user=await User.findOne({email}).select('+password');
+      if(!user){
+        return next(new ErrorHandler('Invalid email or password',401));
+      }
+
+      const isMatch= await user.comparePassword(password);
+      if(!isMatch){
+        return next(new ErrorHandler('Invalid email or password',401));
+      }
+
+      const token=generateToken(user._id);
+
+      res.status(200).json({
+        success:true,
+        message:'User logged in successfully',
+        token,
+        user:{
+          id:user._id,
+          name:user.name,
+          email: user.email
+        }
+      });
+    }catch(error){
+      next(error);
+    }
+  }
+  
+  
+  module.exports = {
+    register,
+    login
+  };
+  
+  `;
+
+
+
+  fs.writeFileSync(
+    path.join(projectPath, 'src/controllers/authController.js'),
+    authController
+  );
+
+  console.log(chalk.green('Auth controller created'));
+}
+
+
+
 function createAxiosUtil(projectPath){
   const axiosUtil = ` const axios = require('axios');
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "backend-scaffold-cli",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "CLI tool to scaffold Express.js backend projects with MongoDB, middleware, and common setup",
   "main": "bin/cli.js",
   "bin": {
     "create-express-backend": "./bin/cli.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
   "keywords": [
     "express",
@@ -32,5 +32,8 @@
     "commander": "^11.0.0",
     "fs-extra": "^11.1.0",
     "inquirer": "^8.2.5"
+  },
+  "devDependencies": {
+    "jest": "^30.4.2"
   }
 }