create-prod-backend 1.3.5 → 1.4.6

package/README.md

@@ -79,24 +79,18 @@ npx create-prod-backend
 ---
 
 ## Supported Dependencies
-
-# Must have
 * express
 * cors
 * dotenv
 * cookie-parser
-
-# Dev Dependency
-* nodemon
-
-# Optinal 
-* bcryptjs
-* zod
-* argon2
-* jsonwebtoken
-* cloudinary
-* multer
-* mongoose
+* nodemon (devDependency)
+* bcryptjs (Optional)
+* zod (Optional)
+* argon2 (Optional)
+* jsonwebtoken (Optional)
+* cloudinary (Optional)
+* multer (Optional)
+* mongoose (Optional)
 
 ---
 

package/package.json

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

package/src/index.js

@@ -1,17 +1,33 @@
 import inquirer from "inquirer";
 import questions from "./prompts/questions.js";
 import { createProject } from "./core/createProject.js";
+import { execSync } from "child_process";
 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 backendapp = await inquirer.prompt([
+      {
+        type: "select",
+        name: "usebackend",
+        message: chalk.bold.yellow("What do you want to create?"),
+        choices: ["Express Backend", "Next.js App"],
+      },
+    ]);
+
+    if (backendapp.usebackend === "Next.js App") {
+      execSync("npx create-next-app@latest", { stdio: "inherit" });
+      return;
+    }
+  
     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("You can change Docker file according to your need"));
     console.log(chalk.yellow("Happy coding! :)"));
   } catch (error) {
     console.error(chalk.red(("Error:", error.message)));

package/src/prompts/questions.js

@@ -18,6 +18,11 @@ export default [
     name: "useMongo",
     message: chalk.bold.yellow("Do you want MongoDB?"),
   },
+  {
+    type: "confirm",
+    name: "useDocker",
+    message: chalk.bold.yellow("Do you want Docker Setup?")
+  },
   {
     type: "confirm",
     name: "ENV",

package/src/services/file.service.js

@@ -2,21 +2,24 @@ import fs from "fs";
 import path from "path";
 
 import { indexTemplate } from "../templates/base/index.template.js";
+import { dockerfileTemplate } from "../templates/docker-setup/docker.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";
+import { dockercomposeTemplate } from "../templates/docker-setup/dockercompose.template.js"
+import { dockerignoreTemplate } from "../templates/docker-setup/dockerignore.template.js"
 
 export function createFiles(projectPath, answer) {
     // index.js
     fs.writeFileSync(
-        path.join(projectPath,"src", "index.js"),
+        path.join(projectPath, "src", "index.js"),
         indexTemplate(answer)
     );
 
     // app.js
     fs.writeFileSync(
-        path.join(projectPath,"src", "app.js"),
+        path.join(projectPath, "src", "app.js"),
         appTemplate(answer)
     );
 
@@ -44,6 +47,13 @@ export function createFiles(projectPath, answer) {
         fs.writeFileSync(path.join(projectPath, ".env"), envTemplate(answer));
     }
 
+    // docker
+    if (answer.useDocker) {
+        fs.writeFileSync(path.join(projectPath, 'Dockerfile'), dockerfileTemplate());
+        fs.writeFileSync(path.join(projectPath, 'docker-compose.yml'), dockercomposeTemplate());
+        fs.writeFileSync(path.join(projectPath, '.dockerignore'), dockerignoreTemplate());
+    }
+
     fs.writeFileSync(
         path.join(projectPath, "README.md"),
         `# ${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)*`

package/src/templates/docker-setup/docker.template.js

@@ -0,0 +1,19 @@
+export const dockerfileTemplate = () => `
+# Base image
+FROM node:18-alpine
+
+# Set working directory
+WORKDIR /app
+
+# Copy package files
+COPY package*.json ./
+
+# Install dependencies
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Start server
+ENTRYPOINT ["node", "src/index.js"]
+`;

package/src/templates/docker-setup/dockercompose.template.js

@@ -0,0 +1,18 @@
+export const dockercomposeTemplate = () => {
+    return `
+version: "3.8"
+
+services:
+  app:
+    build: .
+    container_name: node_app
+    ports:
+      - "5000:5000"
+    volumes:
+      - .:/app
+      - /app/node_modules
+    environment:
+      - PORT=5000
+    command: npm run dev
+`;
+};

package/src/templates/docker-setup/dockerignore.template.js

@@ -0,0 +1,24 @@
+export const dockerignoreTemplate = () => `
+node_modules/
+npm-debug.log
+yarn-error.log
+
+.git
+.gitignore
+
+.env
+.env.local
+
+Dockerfile
+docker-compose.yml
+.dockerignore
+
+coverage
+dist
+build
+
+.vscode
+.idea
+
+*.log
+`