feat: enhance Node.js MongoDB template with authentication, testing, Docker, CI/CD, and update CLI commands to support new features.

Author: Dushyant-Khoda

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: production
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run semantic release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.releaserc.json

@@ -0,0 +1,22 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]"
+      }
+    ]
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+# [Unreleased]
+
+## Added
+
+### Authentication
+
+* Added user registration and login support.
+* Implemented token generation for authenticated sessions.
+* Added OTP verification for phone and email.
+* Added password reset using OTP.
+* Added Joi validation for authentication and OTP routes.
+
+### Testing
+
+* Added Jest and Supertest for API testing.
+* Added a `tests/` directory with base configuration.
+* Added initial test examples such as `health.test.js`.
+
+### Security
+
+* Added Helmet middleware for HTTP header security.
+* Added express-rate-limit for request rate limiting.
+* Added mongo-sanitize and xss-clean to prevent injection attacks.
+* Added configurable CORS middleware.
+
+### Docker
+
+* Added Dockerfile for containerized deployments.
+* Added docker-compose configuration for local API and MongoDB setup.
+* Added `.dockerignore` for optimized Docker builds.
+
+### Monitoring
+
+* Added `/health` endpoint for service status.
+* Added `/health/ready` endpoint for readiness checks.
+
+---
+
+## Changed
+
+### CLI Improvements
+
+* Improved CLI output for better readability.
+* Removed unnecessary visual elements from CLI output.
+* Moved CLI messages to a centralized constants file.
+
+### API Message Handling
+
+* Added `src/constants/Messages.js` for centralized API messages.
+* Controllers and services now use message constants instead of inline text.
+
+### Logging
+
+* Updated internal logs to follow a structured format.
+
+Example:
+
+```
+[FileUpload] Upload started
+[Cloudinary] File uploaded successfully
+```
+
+### Environment Variables
+
+Updated Cloudinary environment variable names:
+
+| Old Name      | New Name           |
+| ------------- | ------------------ |
+| CLOUD_NAME    | CLOUDINARY_NAME    |
+| CLOUD_API_KEY | CLOUDINARY_API_KEY |
+
+---
+
+## Documentation
+
+Added documentation in the `docs/` directory:
+
+* `setup.md` – Project setup instructions
+* `authentication.md` – Authentication and OTP usage
+* `services.md` – Email, AWS S3, and Cloudinary configuration
+* `cli-usage.md` – CLI command usage
+
+Updated the root `README.md` with clearer setup instructions.
+
+---
+
+## Fixed
+
+* Fixed an issue in the CLI `init` command related to inquirer prompt structure.
+* Removed duplicate documentation paths.
+* Cleaned formatting issues in documentation files.

bin/cli.js

@@ -60,9 +60,10 @@ program
     .command("add-controller <name>")
     .alias("c")
     .description("Create a new controller with CRUD methods")
-    .action((name) => {
+    .option("--skip-doc, --sd", "Skip generating documentation")
+    .action((name, opts) => {
         const addControllerCommand = require("../lib/commands/addController");
-        addControllerCommand(name);
+        addControllerCommand(name, { skipDoc: opts.skipDoc || false });
     });
 
 program
@@ -78,18 +79,20 @@ program
     .command("add-router <name>")
     .alias("r")
     .description("Create a new Express router with CRUD routes")
-    .action((name) => {
+    .option("--skip-doc, --sd", "Skip generating documentation")
+    .action((name, opts) => {
         const addRouterCommand = require("../lib/commands/addRouter");
-        addRouterCommand(name);
+        addRouterCommand(name, { skipDoc: opts.skipDoc || false });
     });
 
 program
     .command("add-module <name>")
     .alias("mod")
     .description("Create controller + model + router as a full module")
-    .action((name) => {
+    .option("--skip-doc, --sd", "Skip generating documentation")
+    .action((name, opts) => {
         const addModuleCommand = require("../lib/commands/addModule");
-        addModuleCommand(name);
+        addModuleCommand(name, { skipDoc: opts.skipDoc || false });
     });
 
 program

lib/commands/addController.js

@@ -2,17 +2,20 @@ const fs = require("fs");
 const path = require("path");
 const chalk = require("chalk");
 const { ensureInsideProject, addExportToIndex, toPascalCase } = require("../utils/helpers");
+const { generateDoc } = require("../utils/generateDoc");
+const { CREATE, GENERIC, PREFIX } = require("../../lib/constants");
 
-function addControllerCommand(name) {
+function addControllerCommand(name, options = {}) {
     ensureInsideProject();
 
     const Name = toPascalCase(name);
+    const skipDoc = options.skipDoc || false;
     const fileName = `${Name}Controller`;
     const filePath = path.resolve(process.cwd(), `Src/Controller/${fileName}.js`);
     const indexPath = path.resolve(process.cwd(), "Src/Controller/index.js");
 
     if (fs.existsSync(filePath)) {
-        console.log(chalk.yellow(`\n⚠  ${fileName}.js already exists.\n`));
+        console.log(chalk.yellow(`\n${PREFIX.WARN}${GENERIC.FILE_ALREADY_EXISTS(fileName + ".js")}\n`));
         process.exit(0);
     }
 
@@ -33,12 +36,21 @@ export default ${fileName};
 `;
 
     fs.writeFileSync(filePath, template, "utf-8");
-    console.log(chalk.green(`  ✔ Created Src/Controller/${fileName}.js`));
+    console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.CREATED_FILE("Src/Controller/" + fileName + ".js")}`));
 
     addExportToIndex(indexPath, fileName, fileName);
-    console.log(chalk.green(`  ✔ Updated Src/Controller/index.js`));
+    console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.UPDATED_FILE("Src/Controller/index.js")}`));
+
+    // Generate controller documentation
+    if (!skipDoc) {
+        generateDoc(name, {
+            type: "controller",
+            createdFiles: [`Src/Controller/${fileName}.js`],
+            updatedFiles: ["Src/Controller/index.js"],
+        });
+    }
 
-    console.log(chalk.bold.green(`\n✅ Controller "${fileName}" created successfully!\n`));
+    console.log(chalk.bold.green(`\n${CREATE.CONTROLLER_DONE(fileName)}\n`));
 }
 
 module.exports = addControllerCommand;

lib/commands/addMiddleware.js

@@ -2,21 +2,22 @@ const fs = require("fs");
 const path = require("path");
 const chalk = require("chalk");
 const { ensureInsideProject, addExportToIndex, toPascalCase } = require("../utils/helpers");
+const { CREATE, GENERIC, PREFIX } = require("../../lib/constants");
 
 function addMiddlewareCommand(name) {
-    ensureInsideProject();
+  ensureInsideProject();
 
-    const Name = toPascalCase(name);
-    const fileName = `${Name}Middleware`;
-    const filePath = path.resolve(process.cwd(), `Src/Middleware/${fileName}.js`);
-    const indexPath = path.resolve(process.cwd(), "Src/Middleware/index.js");
+  const Name = toPascalCase(name);
+  const fileName = `${Name}Middleware`;
+  const filePath = path.resolve(process.cwd(), `Src/Middleware/${fileName}.js`);
+  const indexPath = path.resolve(process.cwd(), "Src/Middleware/index.js");
 
-    if (fs.existsSync(filePath)) {
-        console.log(chalk.yellow(`\n⚠  ${fileName}.js already exists.\n`));
-        process.exit(0);
-    }
+  if (fs.existsSync(filePath)) {
+    console.log(chalk.yellow(`\n${PREFIX.WARN}${GENERIC.FILE_ALREADY_EXISTS(fileName + ".js")}\n`));
+    process.exit(0);
+  }
 
-    const template = `const ${fileName} = (req, res, next) => {
+  const template = `const ${fileName} = (req, res, next) => {
   try {
     // Add your middleware logic here
     next();
@@ -28,13 +29,13 @@ function addMiddlewareCommand(name) {
 export default ${fileName};
 `;
 
-    fs.writeFileSync(filePath, template, "utf-8");
-    console.log(chalk.green(`  ✔ Created Src/Middleware/${fileName}.js`));
+  fs.writeFileSync(filePath, template, "utf-8");
+  console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.CREATED_FILE("Src/Middleware/" + fileName + ".js")}`));
 
-    addExportToIndex(indexPath, fileName, fileName);
-    console.log(chalk.green(`  ✔ Updated Src/Middleware/index.js`));
+  addExportToIndex(indexPath, fileName, fileName);
+  console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.UPDATED_FILE("Src/Middleware/index.js")}`));
 
-    console.log(chalk.bold.green(`\n✅ Middleware "${fileName}" created successfully!\n`));
+  console.log(chalk.bold.green(`\n${CREATE.MIDDLEWARE_DONE(fileName)}\n`));
 }
 
 module.exports = addMiddlewareCommand;

lib/commands/addModel.js

@@ -2,21 +2,22 @@ const fs = require("fs");
 const path = require("path");
 const chalk = require("chalk");
 const { ensureInsideProject, addExportToIndex, toPascalCase } = require("../utils/helpers");
+const { CREATE, GENERIC, PREFIX } = require("../../lib/constants");
 
 function addModelCommand(name) {
-    ensureInsideProject();
+  ensureInsideProject();
 
-    const Name = toPascalCase(name);
-    const fileName = `${Name}Model`;
-    const filePath = path.resolve(process.cwd(), `Src/Models/${fileName}.js`);
-    const indexPath = path.resolve(process.cwd(), "Src/Models/index.js");
+  const Name = toPascalCase(name);
+  const fileName = `${Name}Model`;
+  const filePath = path.resolve(process.cwd(), `Src/Models/${fileName}.js`);
+  const indexPath = path.resolve(process.cwd(), "Src/Models/index.js");
 
-    if (fs.existsSync(filePath)) {
-        console.log(chalk.yellow(`\n⚠  ${fileName}.js already exists.\n`));
-        process.exit(0);
-    }
+  if (fs.existsSync(filePath)) {
+    console.log(chalk.yellow(`\n${PREFIX.WARN}${GENERIC.FILE_ALREADY_EXISTS(fileName + ".js")}\n`));
+    process.exit(0);
+  }
 
-    const template = `import mongoose from "mongoose";
+  const template = `import mongoose from "mongoose";
 
 const ${Name}Schema = new mongoose.Schema(
   {
@@ -32,13 +33,13 @@ const ${fileName} = mongoose.model("${Name}", ${Name}Schema);
 export default ${fileName};
 `;
 
-    fs.writeFileSync(filePath, template, "utf-8");
-    console.log(chalk.green(`  ✔ Created Src/Models/${fileName}.js`));
+  fs.writeFileSync(filePath, template, "utf-8");
+  console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.CREATED_FILE("Src/Models/" + fileName + ".js")}`));
 
-    addExportToIndex(indexPath, fileName, fileName);
-    console.log(chalk.green(`  ✔ Updated Src/Models/index.js`));
+  addExportToIndex(indexPath, fileName, fileName);
+  console.log(chalk.green(`${PREFIX.SUCCESS}${CREATE.UPDATED_FILE("Src/Models/index.js")}`));
 
-    console.log(chalk.bold.green(`\n✅ Model "${fileName}" created successfully!\n`));
+  console.log(chalk.bold.green(`\n${CREATE.MODEL_DONE(fileName)}\n`));
 }
 
 module.exports = addModelCommand;