create-prod-backend 1.0.2 → 1.1.2

package/bin/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import runCLI from "../src/index.js";
+
+runCLI();

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "create-prod-backend",
-  "version": "1.0.2",
+  "version": "1.1.2",
   "description": "A cli tool to generate a production-ready backend boilerplate with Express.js, MongoDB, and essential features.",
   "main": "index.js",
   "bin": {
-    "create-prod-backend": "./index.js"
+    "create-prod-backend": "./bin/index.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -20,6 +20,7 @@
   "license": "ISC",
   "type": "module",
   "dependencies": {
+    "chalk": "^5.6.2",
     "inquirer": "^13.3.2"
   }
-}
+}

package/src/core/createProject.js

@@ -0,0 +1,19 @@
+import path from "path";
+import { createFolders } from "../services/folder.service.js";
+import { initPackage } from "../services/package.service.js";
+import { createFiles } from "../services/file.service.js";
+import { installDeps } from "../services/dependency.service.js";
+import chalk from "chalk";
+
+export async function createProject(answer) {
+  const projectPath = path.join(process.cwd(), answer.projectName);
+
+  createFolders(projectPath);
+  initPackage(projectPath);
+  createFiles(projectPath, answer);
+
+  if (answer.npmi) {
+    console.log(chalk.blue("Installing dependencies..."));
+    installDeps(projectPath, answer);
+  }
+}

package/src/index.js

@@ -0,0 +1,20 @@
+import inquirer from "inquirer";
+import questions from "./prompts/questions.js";
+import { createProject } from "./core/createProject.js";
+import chalk from "chalk";
+
+export default async function runCLI() {
+  console.log(chalk.bold.cyan("\n------------------Welcome to the CREATE-PROD-BACKEND CLI------------------\n"));
+
+  try {
+    const answer = await inquirer.prompt(questions);
+
+    await createProject(answer);
+
+    console.log(chalk.green(`\n${chalk.bold(answer.projectName)} project created successfully!\n`));
+    console.log(chalk.yellow("Happy coding! :)"));
+  } catch (error) {
+    console.error(chalk.red(("Error:", error.message)));
+    process.exit(1);
+  }
+}

package/src/prompts/questions.js

@@ -0,0 +1,47 @@
+import fs from "fs";
+import path from "path";
+import chalk from "chalk";
+
+export default [
+  {
+    name: "projectName",
+    message: chalk.bold.yellow("Enter the Project (Folder) Name:"),
+    validate: (input) => {
+      if (!input) return chalk.red("Please enter a valid project name");
+      if (fs.existsSync(path.join(process.cwd(), input)))
+        return chalk.red("Folder already exists");
+      return true;
+    },
+  },
+  {
+    type: "confirm",
+    name: "useMongo",
+    message: chalk.bold.yellow("Do you want MongoDB?"),
+  },
+  {
+    type: "confirm",
+    name: "ENV",
+    message: chalk.bold.yellow("Do you want .env?"),
+  },
+  {
+    type: "checkbox",
+    name: "dependencies",
+    message: chalk.bold.yellow("Select dependencies to install:"),
+    choices: [
+      "express",
+      "nodemon",
+      "cors",
+      "bcryptjs",
+      "dotenv",
+      "jsonwebtoken",
+      "cookie-parser",
+      "cloudinary",
+      "multer",
+    ],
+  },
+  {
+    type: "confirm",
+    name: "npmi",
+    message: chalk.bold.yellow("Do you want to install dependencies?"),
+  },
+];

package/src/services/dependency.service.js

@@ -0,0 +1,35 @@
+import { execSync } from "child_process";
+
+export function installDeps(projectPath, answer) {
+    let deps = [...answer.dependencies];
+
+    if (answer.useMongo) {
+        deps.push("mongoose");
+    }
+
+    deps = deps.map(dep => dep.replace(/['"]/g, "").trim());
+
+    const dev = [];
+    const normal = [];
+
+    deps.forEach((dep) => {
+        if (dep === "nodemon") dev.push(dep);
+        else normal.push(dep);
+    });
+
+    console.log("Installing:", normal, dev); // debug
+
+    if (normal.length) {
+        execSync(`npm i ${normal.join(" ")}`, {
+            cwd: projectPath,
+            stdio: "inherit",
+        });
+    }
+
+    if (dev.length) {
+        execSync(`npm i -D ${dev.join(" ")}`, {
+            cwd: projectPath,
+            stdio: "inherit",
+        });
+    }
+}

package/src/services/file.service.js

@@ -0,0 +1,56 @@
+import fs from "fs";
+import path from "path";
+
+import { indexTemplate } from "../templates/base/index.template.js";
+import { appTemplate } from "../templates/base/app.template.js";
+import { mongoTemplate } from "../templates/db/mongo.template.js";
+import { envTemplate } from "../templates/config/env.template.js";
+import { utilsTemplates } from "../templates/utils/utils.template.js";
+
+export function createFiles(projectPath, answer) {
+    // index.js
+    fs.writeFileSync(
+        path.join(projectPath,"src", "index.js"),
+        indexTemplate(answer)
+    );
+
+    // app.js
+    fs.writeFileSync(
+        path.join(projectPath,"src", "app.js"),
+        appTemplate(answer)
+    );
+
+    // utils
+    Object.entries(utilsTemplates).forEach(([file, content]) => {
+        fs.writeFileSync(path.join(projectPath, "src", "utils", file), content);
+    });
+
+    // constants
+    fs.writeFileSync(
+        path.join(projectPath, "src", "constants.js"),
+        `export const DB_NAME = "your_db_name";`
+    );
+
+    // mongo
+    if (answer.useMongo) {
+        fs.writeFileSync(
+            path.join(projectPath, "src", "db", "connect.js"),
+            mongoTemplate()
+        );
+    }
+
+    // .env
+    if (answer.ENV) {
+        fs.writeFileSync(path.join(projectPath, ".env"), envTemplate());
+    }
+
+    // gitignore
+    fs.writeFileSync(
+        path.join(projectPath, ".gitignore"),
+        `node_modules/
+.env
+dist/
+coverage/
+.DS_Store`
+    );
+}

package/src/services/folder.service.js

@@ -0,0 +1,24 @@
+import fs from "fs";
+import path from "path";
+
+export function createFolders(projectPath) {
+    fs.mkdirSync(projectPath, {
+        recursive: true
+    });
+
+    const folders = [
+        "controllers",
+        "routes",
+        "db",
+        "middlewares",
+        "models",
+        "utils",
+        "public",
+    ];
+
+    folders.forEach((folder) => {
+        fs.mkdirSync(path.join(projectPath, "src", folder), {
+            recursive: true
+        });
+    });
+}

package/src/services/package.service.js

@@ -0,0 +1,21 @@
+import { execSync } from "child_process";
+import fs from "fs";
+import path from "path";
+
+export function initPackage(projectPath) {
+    execSync("npm init -y", { 
+        cwd: projectPath, 
+        stdio: "inherit" 
+    });
+
+    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));
+}

package/src/templates/base/app.template.js

@@ -0,0 +1,24 @@
+export const appTemplate = (answer) => `
+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 };
+`;

package/src/templates/base/index.template.js

@@ -0,0 +1,25 @@
+export const indexTemplate = (answer) => `
+import { app } from "./app.js";
+${answer.useMongo ? `import connectDB from "./db/connect.js";` : ""}
+${answer.ENV ? `import dotenv from "dotenv";\ndotenv.config();` : ""}
+
+const startServer = async () => {
+  try {
+    ${answer.useMongo ? `await connectDB();` : ""}
+
+    app.on("error", (error) => {
+      console.error("App error:", error);
+      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();
+`;

package/src/templates/config/env.template.js

@@ -0,0 +1,12 @@
+export const envTemplate = () => `
+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=*
+`;

package/src/templates/db/mongo.template.js

@@ -0,0 +1,15 @@
+export const mongoTemplate = () => `
+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;
+`;

package/src/templates/utils/utils.template.js

@@ -0,0 +1,58 @@
+export const utilsTemplates = {
+  "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;
+`,
+
+  "ApiResponse.js": `
+class ApiResponse {
+  constructor(statusCode, data, message = "Success") {
+    this.statusCode = statusCode;
+    this.data = data;
+    this.message = message;
+    this.success = statusCode < 400; // basically hamra apiResponse hai to hum statusCode -> 400 se kaam he bheja ga
+  }
+}
+// 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 };
+`,
+
+  "asyncHandler.js": `
+const asyncHandler = (requestHandler) => {
+  return (req, res, next) => {
+    Promise.resolve(requestHandler(req, res, next)).catch((error) =>
+      next(error)
+    );
+  };
+}; 
+
+
+export default asyncHandler;
+`,
+};