create-prod-backend 1.1.5 → 1.3.5

package/README.md

@@ -80,16 +80,23 @@ npx create-prod-backend
 
 ## Supported Dependencies
 
+# Must have
 * express
-* nodemon
 * cors
-* bcryptjs
 * dotenv
-* jsonwebtoken
 * cookie-parser
+
+# Dev Dependency
+* nodemon
+
+# Optinal 
+* bcryptjs
+* zod
+* argon2
+* jsonwebtoken
 * cloudinary
 * multer
-* mongoose (optional)
+* mongoose
 
 ---
 

package/package.json

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

package/src/core/createProject.js

@@ -13,7 +13,16 @@ export async function createProject(answer) {
   createFiles(projectPath, answer);
 
   if (answer.npmi) {
-    console.log(chalk.blue("Installing dependencies..."));
+    console.log(chalk.blue("Installing dependencies...\n"));
     installDeps(projectPath, answer);
   }
+  else {
+    console.log(chalk.yellow("Skipping dependency installation."));
+    answer.auth && console.log(chalk.yellow("Don't forget to install authentication dependencies: jsonwebtoken, bcrypt"));
+    answer.validation && console.log(chalk.yellow("Don't forget to install validation dependency: zod"));
+    answer.fileUpload && console.log(chalk.yellow("Don't forget to install file upload dependencies: multer, cloudinary"));
+    answer.devTools && console.log(chalk.yellow("Don't forget to install dev tool dependency: nodemon"));
+    answer.useMongo && console.log(chalk.yellow("Don't forget to install MongoDB dependency: mongoose"));
+  }
+
 }

package/src/prompts/questions.js

@@ -24,20 +24,28 @@ export default [
     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: "select",
+    name: "auth",
+    message: chalk.bold.yellow("Add Authentication : "),
+    choices: ["No Authentication", "JWT + bcryptjs", "JWT + argon2"],
+  },
+
+  {
+    type: "confirm",
+    name: "validation",
+    message: chalk.bold.yellow("Add Validation (Zod)?"),
+  },
+
+  {
+    type: "confirm",
+    name: "fileUpload",
+    message: chalk.bold.yellow("Add File Upload (Multer + Cloudinary)?"),
+  },
+
+  {
+    type: "confirm",
+    name: "devTools",
+    message: chalk.bold.yellow("Add Dev Tools (Nodemon)?"),
   },
   {
     type: "confirm",

package/src/services/dependency.service.js

@@ -1,13 +1,18 @@
+import chalk from "chalk";
 import { execSync } from "child_process";
 
 export function installDeps(projectPath, answer) {
-    let deps = [...answer.dependencies];
+    let deps = ["express","cors","dotenv","cookie-parser"];
 
-    if (answer.useMongo) {
-        deps.push("mongoose");
-    }
+    if(answer.auth === "JWT + bcryptjs") deps.push("jsonwebtoken", "bcryptjs");
+    if(answer.auth === "JWT + argon2") deps.push("jsonwebtoken", "argon2");
+    if(answer.validation) deps.push("zod");
+    if(answer.fileUpload) deps.push("multer", "cloudinary");
+    if(answer.devTools) deps.push("nodemon");
+
+    if (answer.useMongo) deps.push("mongoose");
 
-    deps = deps.map(dep => dep.replace(/['"]/g, "").trim());
+    // deps = deps.map(dep => dep.replace(/['"]/g, "").trim());
 
     const dev = [];
     const normal = [];
@@ -17,7 +22,7 @@ export function installDeps(projectPath, answer) {
         else normal.push(dep);
     });
 
-    console.log("Installing:", normal, dev); // debug
+    console.log(chalk.cyanBright("Installing:"), normal, dev); // debug
 
     if (normal.length) {
         execSync(`npm i ${normal.join(" ")}`, {

package/src/services/file.service.js

@@ -41,12 +41,12 @@ export function createFiles(projectPath, answer) {
 
     // .env
     if (answer.ENV) {
-        fs.writeFileSync(path.join(projectPath, ".env"), envTemplate());
+        fs.writeFileSync(path.join(projectPath, ".env"), envTemplate(answer));
     }
 
     fs.writeFileSync(
         path.join(projectPath, "README.md"),
-        `# ${answer.projectName}\n\nGenerated with create-prod-backend CLI.`
+        `# ${answer.projectName}\n\nGenerated with create-prod-backend CLI. Customize your README to provide instructions and information about your project. \n\n## Setup\n\n1. Install dependencies: \`npm install\`\n2. Start the server: \`npm start\` \n\n## Environment Variables\n\n- \`PORT\`: Port number for the server (default: 3000)\n- \`MONGO_URI\`: MongoDB connection string (if using MongoDB)\n- \`JWT_SECRET\`: Secret key for JWT authentication (if using auth)\n- \`CLOUDINARY_CLOUD_NAME\`, \`CLOUDINARY_API_KEY\`, \`CLOUDINARY_API_SECRET\`: Cloudinary credentials (if using file upload) \n\n## Features\n\n- Express server setup\n- CORS enabled\n- Environment variable support with dotenv\n${answer.auth ? "- JWT authentication with jsonwebtoken and bcrypt\n" : ""}${answer.validation ? "- Request validation with Zod\n" : ""}${answer.fileUpload ? "- File upload handling with Multer and Cloudinary\n" : ""}${answer.devTools ? "- Development tools with Nodemon\n" : ""}${answer.useMongo ? "- MongoDB integration with Mongoose\n" : ""}\n\n## License\n\nThis project is licensed under the ISC License. \n\n---\n\n*Generated by [create-prod-backend](https://www.npmjs.com/package/create-prod-backend)*`
     );
 
     // gitignore

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

@@ -1,22 +1,19 @@
 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";` : ""}
+import cors from "cors";
+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());` : ""}
+app.use(cookieParser());
 
 // routes here
 

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

@@ -1,12 +1,16 @@
-export const envTemplate = () => `
+export const envTemplate = (answer) => `
 PORT=3000
 MONGO_URI=your_mongodb_uri
 
-ACCESS_TOKEN_SECRET=your_access_token
+${answer.auth ? `ACCESS_TOKEN_SECRET=your_access_token
 ACCESS_TOKEN_EXPIRY=2d
 
 REFRESH_TOKEN_SECRET=your_refresh_token
-REFRESH_TOKEN_EXPIRY=20d
+REFRESH_TOKEN_EXPIRY=20d` : ""}
+
+${answer.fileUpload ? `CLOUDINARY_CLOUD_NAME=your_cloud_name
+CLOUDINARY_API_KEY=your_api_key
+CLOUDINARY_API_SECRET=your_api_secret` : ""}
 
 CORS_ORIGIN=*
 `;