backend-scaffold-cli 1.4.0 → 1.5.1

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

@@ -48,6 +48,12 @@ program
           name: 'installDeps',
           message: 'Install dependencies now?',
           default: true
+        },
+        {
+          type: 'confirm',
+          name: 'useAxios',
+          message: 'Include axios (for external API calls)?',
+          default: true
         }
       ]);
 
@@ -74,6 +80,9 @@ program
       if (answers.useAuth) {
         createUserModel(projectPath);
       }
+      if(answers.useAxios){
+        createAxiosUtil(projectPath);
+      }
 
       console.log(chalk.cyan(' Initializing git repository...'));
       execSync('git init', { cwd: projectPath });
@@ -149,6 +158,7 @@ const createConfigFiles = (projectPath, answers) => {
       ...(answers.useValidation && { joi: '^17.9.0' }),
       ...(answers.useRateLimit && { 'express-rate-limit': '^6.7.0' }),
       ...(answers.useFileUpload && { multer: '^2.0.0' }),
+      ...(answers.useAxios && { axios: '^1.6.0' }),
 
     },
     devDependencies: {
@@ -664,4 +674,76 @@ function createUserModel(projectPath) {
     )
 
     console.log(chalk.green('User model created'));
+}
+
+
+
+
+function createAxiosUtil(projectPath){
+  const axiosUtil = ` const axios = require('axios');
+
+  //create an axios instance with default config
+  const axiosInstance = axios.create({
+    baseURL: process.env.API_BASE_URL || '',
+    timeout: 10000,
+    headers:{
+      'Content-Type' : 'application/json',
+    }
+  });
+
+  //request interceptor
+  axiosInstance.interceptors.request.use(
+    (config) =>{
+      console.log(\`Making request to: \${config.url}\`);;
+      return config;
+    },
+    (error) => Promise.reject(error)
+  );
+
+  //response interceptor
+  axiosInstance.interceptors.response.use(
+    (response) => response,
+    (error) => {
+      console.error('API call error: ', error.response ? error.response.data : error.message);
+      return Promise.reject(error);
+    }
+  );
+
+  //fetch data function
+  const fetchData = async (url) => {
+    try{
+      const response = await axiosInstance.get(url);
+      return response.data;
+    }catch(error){
+      throw new Error(\`Failed to fetch data: \${error.message}\`);
+    }
+  };
+
+  //post data function
+  const postData = async (url, data) => {
+    try{
+      const response = await axiosInstance.post(url, data);
+      return response.data;
+    }catch(error){
+      throw new Error(\`Failed to post data: \${error.message}\`);
+    }
+  };
+
+  module.exports = {
+    axiosInstance,
+    fetchData,
+    postData,
+  };
+  
+  
+  
+  `;
+
+
+  fs.writeFileSync(
+    path.join(projectPath, 'src/utils/axiosUtil.js'),
+    axiosUtil
+  );
+
+  console.log(chalk.green('Axios utility created'));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-scaffold-cli",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "CLI tool to scaffold Express.js backend projects with MongoDB, middleware, and common setup",
   "main": "bin/cli.js",
   "bin": {