create-express-kickstart 1.0.0 → 1.0.1

package/nodejs-app/.env.example

@@ -0,0 +1,8 @@
+PORT=8000
+MONGODB_URI=mongodb://localhost:27017/
+CORS_ORIGIN=*
+NODE_ENV=development
+
+# Rate Limiting
+RATE_LIMIT_WINDOW_MS=900000 # 15 minutes in milliseconds
+RATE_LIMIT_MAX=100 # Maximum requests per windowMs

package/nodejs-app/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "nodejs-app",
+  "version": "1.0.0",
+  "description": "description",
+  "main": "src/server.js",
+  "type": "module",
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon src/server.js",
+    "format": "prettier --write \"src/**/*.{js,json}\""
+  },
+  "imports": {
+    "#*": "./src/*"
+  },
+  "keywords": [
+    "express",
+    "node",
+    "api"
+  ],
+  "author": "aaaaaaaaaaa",
+  "license": "ISC"
+}

package/nodejs-app/src/app.js

@@ -0,0 +1,75 @@
+import express from "express";
+import cors from "cors";
+import cookieParser from "cookie-parser";
+import helmet from "helmet";
+import pinoHttp from "pino-http";
+import rateLimit from "express-rate-limit";
+import { errorHandler } from "#middlewares/errorHandler.middleware.js";
+
+// Import routers
+import healthcheckRouter from "#routes/healthcheck.routes.js";
+
+const app = express();
+
+// Security HTTP headers
+app.use(helmet());
+
+// Rate Limiting
+const limiter = rateLimit({
+    windowMs: process.env.RATE_LIMIT_WINDOW_MS || 15 * 60 * 1000, // Default 15 minutes
+    limit: process.env.RATE_LIMIT_MAX || 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes)
+    standardHeaders: 'draft-7', // draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header
+    legacyHeaders: false, // Disable the `X-RateLimit-*` headers
+    message: "Too many requests from this IP, please try again later"
+});
+app.use("/api", limiter); // Apply rate limiting to all API routes
+
+// Logging
+app.use(pinoHttp({
+    customLogLevel: function (req, res, err) {
+        if (res.statusCode >= 400 && res.statusCode < 500) {
+            return 'warn'
+        } else if (res.statusCode >= 500 || err) {
+            return 'error'
+        } else if (res.statusCode >= 300 && res.statusCode < 400) {
+            return 'silent'
+        }
+        return 'info'
+    },
+    // Dynamically require pino-pretty if in dev and it exists, else undefined
+    transport: process.env.NODE_ENV === "development" ? (function() {
+        try {
+            import("pino-pretty");
+            return {
+                target: 'pino-pretty',
+                options: { colorize: true }
+            };
+        } catch (e) {
+            return undefined;
+        }
+    })() : undefined
+}));
+
+// CORS setup
+app.use(
+    cors({
+        origin: process.env.CORS_ORIGIN || "*", // Fallback to allowing everything
+        credentials: true, // Allow cookies with requests
+    })
+);
+
+// Payload sizes and forms
+app.use(express.json({ limit: "16kb" }));
+app.use(express.urlencoded({ extended: true, limit: "16kb" }));
+app.use(express.static("public")); 
+app.use(cookieParser());
+
+// -------- API ROUTES ---------
+// Mount routers
+app.use("/api/v1/healthcheck", healthcheckRouter);
+
+// Global Error Handler
+// Always add this as the very last middleware
+app.use(errorHandler);
+
+export { app };

package/nodejs-app/src/controllers/healthcheck.controller.js

@@ -0,0 +1,17 @@
+import { ApiError } from "#utils/ApiError.js";
+import { ApiResponse } from "#utils/ApiResponse.js";
+import { asyncHandler } from "#utils/asyncHandler.js";
+
+const healthcheck = asyncHandler(async (req, res) => {
+    // Basic health check
+    return res
+        .status(200)
+        .json(new ApiResponse(200, { status: "OK", timestamp: Date.now() }, "App is running smoothly"));
+});
+
+const triggerError = asyncHandler(async (req, res) => {
+    // Dummy route to test the global error handler
+    throw new ApiError(400, "This is a custom error thrown for testing purposes.");
+});
+
+export { healthcheck, triggerError };

package/nodejs-app/src/db/index.js

@@ -0,0 +1,14 @@
+import mongoose from "mongoose";
+import { DB_NAME } from "#utils/constants.js";
+
+const connectDB = async () => {
+    try {
+        const connectionInstance = await mongoose.connect(`${process.env.MONGODB_URI}/${DB_NAME}`);
+        console.log(`\n MongoDB connected !! DB HOST: ${connectionInstance.connection.host}`);
+    } catch (error) {
+        console.error("MONGODB connection FAILED ", error);
+        process.exit(1);
+    }
+};
+
+export default connectDB;

package/nodejs-app/src/middlewares/errorHandler.middleware.js

@@ -0,0 +1,37 @@
+import { ApiError } from '#utils/ApiError.js';
+
+/**
+ * Global Error Handler Middleware
+ * @param {Error} err
+ * @param {Request} req
+ * @param {Response} res
+ * @param {NextFunction} next
+ */
+const errorHandler = (err, req, res, next) => {
+    let error = err;
+
+    // If the error is not an instance of ApiError, transform it into one
+    if (!(error instanceof ApiError)) {
+        const statusCode = error.statusCode ? error.statusCode : 500;
+        const message = error.message || "Internal Server Error";
+        
+        error = new ApiError(
+            statusCode,
+            message,
+            error?.errors || [], // Pass down any validation errors
+            err.stack // Keep the original stack trace
+        );
+    }
+
+    // Now format the consistent response
+    const response = {
+        ...error,
+        message: error.message,
+        ...(process.env.NODE_ENV === 'development' ? { stack: error.stack } : {})
+    };
+
+    // Send the JSON response
+    return res.status(error.statusCode).json(response);
+};
+
+export { errorHandler };

package/nodejs-app/src/models/example-model.js

@@ -0,0 +1,18 @@
+//example-model.js
+import mongoose from "mongoose";
+
+const exampleSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: [true, "Name is required"],
+    },
+    age: {
+        type: Number,
+        required: [true, "Age is required"],
+    },
+    email: {
+        type: String,
+        required: [true, "Email is required"],
+        unique: true,
+    },
+});

package/nodejs-app/src/routes/healthcheck.routes.js

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import { healthcheck, triggerError } from '#controllers/healthcheck.controller.js';
+
+const router = Router();
+
+router.route('/').get(healthcheck);
+router.route('/error').get(triggerError);
+
+export default router;

package/nodejs-app/src/server.js

@@ -0,0 +1,27 @@
+import dotenv from "dotenv";
+import { app } from "#app.js";
+
+// Load environment variables from .env file
+dotenv.config({
+    path: './.env'
+});
+
+import connectDB from "#db/index.js";
+
+const PORT = process.env.PORT || 8000;
+
+connectDB()
+    .then(() => {
+        app.listen(PORT, () => {
+            console.log(`Server is running at port : ${PORT}`);
+        });
+    })
+    .catch((err) => {
+        console.log("MONGO db connection failed !!! ", err);
+    });
+
+process.on("unhandledRejection", (err) => {
+    console.log("UNHANDLED REJECTION! Shutting down...");
+    console.log(err.name, err.message);
+    process.exit(1);
+});

package/nodejs-app/src/utils/ApiError.js

@@ -0,0 +1,23 @@
+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 { ApiError }

package/nodejs-app/src/utils/ApiResponse.js

@@ -0,0 +1,10 @@
+class ApiResponse {
+    constructor(statusCode, data, message = "Success") {
+        this.statusCode = statusCode;
+        this.data = data;
+        this.message = message;
+        this.success = statusCode < 400; // Success is true if status code is not an error level
+    }
+}
+
+export { ApiResponse }

package/nodejs-app/src/utils/asyncHandler.js

@@ -0,0 +1,7 @@
+const asyncHandler = (requestHandler) => {
+    return (req, res, next) => {
+        Promise.resolve(requestHandler(req, res, next)).catch((err) => next(err));
+    };
+};
+
+export { asyncHandler };

package/nodejs-app/src/utils/constants.js

@@ -0,0 +1 @@
+export const DB_NAME = "my_app_db";

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "create-express-kickstart",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Production-ready CLI starter for Express APIs",
   "main": "bin/cli.js",
   "bin": {
-    "create-express-kickstart": "./bin/cli.js"
+    "create-express-kickstart": "bin/cli.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -21,6 +21,5 @@
   "author": "Your Name",
   "license": "ISC",
   "type": "module",
-  "dependencies": {
-  }
+  "dependencies": {}
 }