create-prod-backend 1.1.2 → 1.1.4

package/README.md

@@ -1,12 +1,181 @@
-# create-prod-backend 🚀
+# create-prod-backend
 
-CLI tool to generate production-ready backend structure.
+Build a **production-ready Express backend** in seconds — no boilerplate, no setup headaches.
 
-## Usage
+---
+
+##  Installation
 
+Use directly with **npx** (recommended):
+
+```bash
 npx create-prod-backend
+```
+
+Or install globally:
+
+```bash
+npm install -g create-prod-backend
+create-prod-backend
+```
+
+---
 
 ## Features
-- MongoDB setup
-- ENV config
-- Dependency selection
+
+*  Instant Express.js backend setup
+*  Clean and scalable folder structure
+*  Optional MongoDB integration
+*  Environment variable support (.env)
+*  Select dependencies interactively
+*  Production-ready scripts
+*  Developer-friendly CLI
+
+---
+
+## What It Generates
+
+```
+project-name/
+│
+├── src/
+│   ├── controllers/
+│   ├── routes/
+│   ├── models/
+│   ├── middlewares/
+│   ├── utils/
+│   ├── db/
+│   │
+│   ├── app.js
+│   ├── index.js
+│   └── constants.js
+│
+├── public/
+│
+├── .env
+├── .gitignore
+├── package.json
+└── README.md
+```
+
+---
+
+## Usage
+
+Run the CLI:
+
+```bash
+npx create-prod-backend
+```
+
+### You’ll be prompted for:
+
+* Project name
+* MongoDB setup (Yes/No)
+* .env file (Yes/No)
+* Dependencies to install
+* Auto install dependencies
+
+---
+
+## Supported Dependencies
+
+* express
+* nodemon
+* cors
+* bcryptjs
+* dotenv
+* jsonwebtoken
+* cookie-parser
+* cloudinary
+* multer
+* mongoose (optional)
+
+---
+
+## Scripts
+
+After setup:
+
+```bash
+npm run dev     # Development (nodemon)
+npm start       # Production
+```
+
+---
+
+## Example
+
+```bash
+npx create-prod-backend
+
+✔ Enter project name: my-app
+✔ Use MongoDB: Yes
+✔ Use .env: Yes
+✔ Install dependencies: Yes
+```
+
+Your backend is ready!
+
+---
+
+## Tech Stack
+
+* Node.js
+* Express.js
+* MongoDB (optional)
+* Inquirer (CLI prompts)
+* Chalk (CLI styling)
+
+---
+
+## Upcoming Features
+
+* Service layer support
+* Auth template (JWT)
+* Docker setup
+* API documentation (Swagger)
+* TypeScript support
+
+---
+
+## Contributing
+
+Contributions are welcome!
+
+```bash
+git clone https://github.com/codeurge123/create-prod-backend
+cd create-prod-backend
+npm install
+```
+
+---
+
+## License
+
+ISC License
+
+---
+
+## Author
+
+Made by **codeurge316 - @yashbansal**
+
+---
+
+## Support
+
+If you like this project:
+
+* Star the repo
+* Share with others
+* Suggest new features
+
+---
+
+## Final Thought
+
+Stop wasting time setting up backend boilerplate.
+Start building real projects.
+
+- **create-prod-backend** does the setup — you build the product.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-prod-backend",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "A cli tool to generate a production-ready backend boilerplate with Express.js, MongoDB, and essential features.",
   "main": "index.js",
   "bin": {

package/src/services/file.service.js

@@ -44,6 +44,11 @@ export function createFiles(projectPath, answer) {
         fs.writeFileSync(path.join(projectPath, ".env"), envTemplate());
     }
 
+    fs.writeFileSync(
+        path.join(projectPath, "README.md"),
+        `# ${answer.projectName}\n\nGenerated with create-prod-backend CLI.`
+    );
+
     // gitignore
     fs.writeFileSync(
         path.join(projectPath, ".gitignore"),

package/src/services/folder.service.js

@@ -17,7 +17,12 @@ export function createFolders(projectPath) {
     ];
 
     folders.forEach((folder) => {
-        fs.mkdirSync(path.join(projectPath, "src", folder), {
+        const folderPath =
+            folder === "public"
+                ? path.join(projectPath, folder, 'temp') 
+                : path.join(projectPath, "src", folder); 
+
+        fs.mkdirSync(folderPath, {
             recursive: true
         });
     });

package/index.js

@@ -1,297 +0,0 @@
-#!/usr/bin/env node
-
-import inquirer from "inquirer";
-import { execSync } from "child_process";
-import fs from "fs";
-import path from "path";
-
-console.log("Welcome to the Express Backend Generator !!");
-
-// answer object will have projectName, useMongo, ENV, dependencies, npmi
-// to access these values we can use answer.projectName, answer.useMongo, answer.ENV, answer.dependencies, answer.npmi
-
-// through message we are taking input from terminal and name is for variable name and type is for type of input like confirm, checkbox etc and validate is for validation of input
-try {
-    const answer = await inquirer.prompt([
-        {
-            name: "projectName",
-            message: "Enter the Project (Folder) Name:",
-            validate: (input) => {
-                if (!input) return "Please enter a valid project name";
-                if (fs.existsSync(path.join(process.cwd(), input)))
-                    return "Folder already exists";
-                return true;
-            },
-        },
-        {
-            type: "confirm",
-            name: "useMongo",
-            message: "Do you want MongoDB?",
-        },
-        {
-            type: "confirm",
-            name: "ENV",
-            message: "Do you want .env?",
-        },
-        {
-            type: "checkbox",
-            name: "dependencies",
-            message: "Select dependencies to install:",
-            choices: [
-                "express",
-                "nodemon",
-                "cors",
-                "bcryptjs",
-                "dotenv",
-                "jsonwebtoken",
-                "cookie-parser",
-                "cloudinary",
-                "multer",
-            ],
-        },
-        {
-            type: "confirm",
-            name: "npmi",
-            message: "Do you want to install dependencies?",
-        },
-    ]);
-
-    const projectPath = path.join(process.cwd(), answer.projectName);
-
-    // Create root folder
-    fs.mkdirSync(projectPath, { recursive: true });
-
-    // Folder structure
-    const folders = [
-        "controllers",
-        "routes",
-        "db",
-        "middlewares",
-        "models",
-        "utils",
-        "public",
-    ];
-
-    folders.forEach((folder) => {
-        fs.mkdirSync(path.join(projectPath, folder), { recursive: true });
-    });
-
-    // Initialize npm
-    execSync("npm init -y", { cwd: projectPath, stdio: "inherit" });
-
-    // Fix package.json
-    const pkgPath = path.join(projectPath, "package.json");
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
-
-    pkg.type = "module";
-    pkg.scripts = {
-        start: "node index.js",
-        dev: "nodemon index.js",
-    };
-
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
-
-    // ---------------- UTILS ----------------
-    fs.writeFileSync(
-        path.join(projectPath, "utils", "ApiError.js"),
-        `
-class ApiError extends Error {
-  constructor(
-    statusCode,
-    message = "Something went wrong",
-    errors = [],
-    stack = ""
-  ) {
-    super(message);
-    this.statusCode = statusCode;
-    this.data = null;
-    this.message = message;
-    this.success = false;
-    this.errors = errors;
-
-    if (stack) {
-      this.stack = stack;
-    } else {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-}
-
-export default ApiError;
-`
-    );
-
-    fs.writeFileSync(
-        path.join(projectPath, "utils", "ApiResponse.js"),
-        `class ApiResponse {
-  constructor(statusCode, data, message = "Success") {
-    this.statusCode = statusCode;
-    this.data = data;
-    this.message = message;
-    this.success = statusCode < 400;
-  }
-}
-// basically statusCode ka knowledge hona chiya aap ke pass
-// Informational responses (100 – 199)
-// Successful responses (200 – 299)
-// Redirection messages (300 – 399)
-// Client error responses (400 – 499)
-// Server error responses (500 – 599)
-
-export { ApiResponse };
-`
-    );
-
-    fs.writeFileSync(
-        path.join(projectPath, "utils", "asyncHandler.js"),
-        `const asyncHandler = (requestHandler) => {
-  return (req, res, next) => {
-    Promise.resolve(requestHandler(req, res, next)).catch((error) =>
-      next(error)
-    );
-  };
-}; 
-
-export default asyncHandler;`
-    );
-
-    // ---------------- CORE FILES ----------------
-    const indexContent = `
-import { app } from "./app.js";
-${answer.useMongo ? `import connectDB from "./db/connect.js";` : ""}
-${answer.ENV ? `import dotenv from "dotenv"; \n dotenv.config();` : ""}
-
-const startServer = async () => {
-  try {
-    ${answer.useMongo ? `await connectDB();` : ""}
-    app.on('error', (error) => {
-        console.log('app is facing error while connecting with db')
-        throw error
-    })
-    app.listen(process.env.PORT || 3000, () => {
-      console.log("Server running on port", process.env.PORT || 3000);
-    });
-
-  } catch (error) {
-    console.error("Server failed to start", error);
-  }
-};
-
-startServer();
-`;
-
-    fs.writeFileSync(path.join(projectPath, "index.js"), indexContent);
-
-    fs.writeFileSync(
-        path.join(projectPath, "app.js"),
-        `import express from "express";
-${answer.dependencies.includes("cors") ? `import cors from "cors";` : ""}
-${answer.dependencies.includes("cookie-parser") ? `import cookieParser from "cookie-parser";` : ""}
-
-const app = express();
-
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-app.use(express.static("public"));
-
-${answer.dependencies.includes("cors") ? `
-app.use(cors({
-  origin: process.env.CORS_ORIGIN || "*",
-  credentials: true
-}));
-` : ""}
-
-${answer.dependencies.includes("cookie-parser") ? `app.use(cookieParser());` : ""}
-
-// routes here
-
-export { app };`
-    );
-
-    fs.writeFileSync(
-        path.join(projectPath, "constants.js"),
-        `export const DB_NAME = "your_db_name";`
-    );
-
-    // ---------------- MONGODB ----------------
-    let deps = [...answer.dependencies];
-
-    if (answer.useMongo) {
-        deps.push("mongoose");
-
-        fs.writeFileSync(
-            path.join(projectPath, "db", "connect.js"),
-            `import mongoose from "mongoose";
-
-const connectDB = async () => {
-  try {
-    const conn = await mongoose.connect(process.env.MONGO_URI);
-    console.log("MongoDB connected:", conn.connection.host);
-  } catch (error) {
-    console.error("MongoDB connection FAILED", error);
-    process.exit(1);
-  }
-};
-
-export default connectDB;`
-        );
-    }
-
-    // ---------------- ENV ----------------
-    if (answer.ENV) {
-        fs.writeFileSync(
-            path.join(projectPath, ".env"),
-            `PORT=3000
-MONGO_URI=your_mongodb_uri
-
-ACCESS_TOKEN_SECRET=your_access_token
-ACCESS_TOKEN_EXPIRY=2d
-
-REFRESH_TOKEN_SECRET=your_refresh_token
-REFRESH_TOKEN_EXPIRY=20d
-
-CORS_ORIGIN=*`
-        );
-    }
-
-    // ---------------- GITIGNORE ----------------
-    fs.writeFileSync(
-        path.join(projectPath, ".gitignore"),
-        `node_modules/
-.env
-dist/
-coverage/
-.DS_Store`
-    );
-
-    // ---------------- INSTALL DEPENDENCIES ----------------
-    const devDeps = [];
-    const normalDeps = [];
-
-    deps.forEach((dep) => {
-        if (dep === "nodemon") devDeps.push(dep);
-        else normalDeps.push(dep);
-    });
-
-    if (answer.npmi) {
-        if (normalDeps.length) {
-            execSync(`npm i ${normalDeps.join(" ")}`, {
-                cwd: projectPath,
-                stdio: "inherit",
-            });
-        }
-
-        if (devDeps.length) {
-            execSync(`npm i -D ${devDeps.join(" ")}`, {
-                cwd: projectPath,
-                stdio: "inherit",
-            });
-        }
-    }
-
-    console.log(`\n${answer.projectName} project created successfully!\n`);
-    console.log("Happy coding! :)");
-} catch (error) {
-    console.error("Error:", error.message);
-    process.exit(1);
-}