@ifecodes/backend-template 1.1.3 → 1.1.5

package/template/base/js/eslint.config.js

@@ -0,0 +1,31 @@
+module.exports = [
+  {
+    ignores: ["node_modules/**", "dist/**"],
+  },
+  {
+    files: ["src/**/*.js"],
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: "module",
+      globals: {
+        console: "readonly",
+        process: "readonly",
+        Buffer: "readonly",
+        __dirname: "readonly",
+        __filename: "readonly",
+        require: "readonly",
+        module: "readonly",
+        exports: "writable",
+        global: "readonly",
+        setTimeout: "readonly",
+        setInterval: "readonly",
+        clearTimeout: "readonly",
+        clearInterval: "readonly",
+      },
+    },
+    rules: {
+      "no-unused-vars": "warn",
+      "no-undef": "error",
+    },
+  },
+];

package/template/base/js/package.json

@@ -0,0 +1,28 @@
+{
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "nodemon --exec node src/server.js",
+    "start": "node src/server.js",
+    "lint": "eslint \"src/**/*.js\"",
+    "format": "prettier --write \"src/**/*.{js,json}\"",
+    "check-format": "prettier --check \"src/**/*.{js,json}\"",
+    "prepare": "husky"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "dotenv": "^16.3.1",
+    "express": "^5.2.1"
+  },
+  "devDependencies": {
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+     "nodemon": "^3.0.2",
+    "prettier": "^3.7.4"
+  }
+}

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

@@ -0,0 +1,15 @@
+const express = require("express");
+const router = require("./routes");
+/*__IMPORTS__*/
+
+const app = express();
+
+// Parse JSON request bodies
+app.use(express.json());
+
+/*__MIDDLEWARE__*/
+
+// Connect routes
+app.use(router);
+
+module.exports = app;

package/template/base/js/src/config/db.js

@@ -0,0 +1,8 @@
+// MongoDB connection will be added here when authentication is enabled
+const connectDB = async () => {
+  // Database connection placeholder
+};
+
+module.exports = {
+  connectDB,
+};

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

@@ -0,0 +1,14 @@
+const dotenv = require("dotenv");
+dotenv.config();
+
+const ENV = {
+ PORT: process.env.PORT,
+  /*__ALLOWED_ORIGIN__*/
+  NODE_ENV: process.env.NODE_ENV,
+  /*__MONGO_URI__*/
+  /*__JWT_SECRET__*/
+};
+
+module.exports = {
+  ENV,
+};

package/template/base/js/src/config/index.js

@@ -0,0 +1,7 @@
+const { connectDB } = require("./db");
+const { ENV } = require("./env");
+
+module.exports = {
+  connectDB,
+  ENV,
+};

package/template/base/js/src/middlewares/index.js

@@ -0,0 +1,9 @@
+const methodNotAllowedHandler = require("./method-not-allowed.middleware");
+const { notFound } = require("./not-found.middleware");
+const { rootHandler } = require("./root.middleware");
+
+module.exports = {
+  methodNotAllowedHandler,
+  notFound,
+  rootHandler,
+};

package/template/base/js/src/middlewares/method-not-allowed.middleware.js

@@ -0,0 +1,13 @@
+const methodNotAllowed = (allowedMethods) => (req, res, next) => {
+  if (!allowedMethods.includes(req.method)) {
+    res.set("Allow", allowedMethods.join(", "));
+    return res.status(405).json({
+      status: "error",
+      message: `Method ${req.method} not allowed for ${req.originalUrl}`,
+      allowed: allowedMethods,
+    });
+  }
+  next();
+};
+
+module.exports = methodNotAllowed;

package/template/base/js/src/middlewares/not-found.middleware.js

@@ -0,0 +1,10 @@
+const notFound = (req, res) => {
+  res.status(404).json({
+    status: "error",
+    message: `Route ${req.originalUrl} not found`,
+  });
+};
+
+module.exports = {
+  notFound,
+};

package/template/base/js/src/middlewares/root.middleware.js

@@ -0,0 +1,16 @@
+const rootHandler = (_, res) => {
+  res.json({
+    name: "/*__PROJECT_NAME__*/",
+    type: "/*__PROJECT_TYPE__*/",
+    version: "1.0.0",
+    status: "running",
+    endpoints: {
+      health: "/api/v1/health",
+      /*__AUTH_ENDPOINT__*/
+    },
+  });
+};
+
+module.exports = {
+  rootHandler,
+};

package/template/base/js/src/modules/index.js

@@ -0,0 +1,8 @@
+const { Router } = require("express");
+const V1Routes = require("./v1");
+
+const router = Router();
+
+router.use("/v1", V1Routes);
+
+module.exports = router;

package/template/base/js/src/modules/v1/health/health.controller.js

@@ -0,0 +1,21 @@
+const { logger } = require("../../../utils");
+
+const healthCheck = async (_, res) => {
+  logger.info("Health", "healthy");
+
+  return res.status(200).json({
+    status: "healthy",
+    uptime: process.uptime(),
+    timestamp: new Date().toISOString(),
+    services: {
+      memory: {
+        rss: process.memoryUsage().rss,
+        heapUsed: process.memoryUsage().heapUsed,
+      },
+    },
+  });
+};
+
+module.exports = {
+  healthCheck
+};

package/template/base/js/src/modules/v1/health/health.route.js

@@ -0,0 +1,9 @@
+const { Router } = require("express");
+const { healthCheck } = require("./health.controller");
+const { methodNotAllowedHandler } = require("../../../middlewares");
+
+const router = Router();
+router.use(methodNotAllowedHandler(["GET"]));
+router.get("/", healthCheck);
+
+module.exports = router;

package/template/base/js/src/modules/v1/health/index.js

@@ -0,0 +1,5 @@
+const healthRoutes = require("./health.route");
+
+module.exports = {
+  healthRoutes,
+};

package/template/base/js/src/modules/v1/index.js

@@ -0,0 +1,8 @@
+const { Router } = require("express");
+const { healthRoutes } = require("./health");
+
+const router = Router();
+
+router.use("/health", healthRoutes);
+
+module.exports = router;

package/template/base/js/src/routes.js

@@ -0,0 +1,16 @@
+const { Router } = require("express");
+const modulesRouter = require("./modules");
+const { notFound, rootHandler } = require("./middlewares");
+
+const router = Router();
+
+// Root endpoint
+router.get("/", rootHandler);
+
+router.use("/api", modulesRouter);
+
+// 404 handler - must be last
+router.use(notFound);
+
+module.exports = router;
+

package/template/base/js/src/server.js

@@ -0,0 +1,18 @@
+const app = require("./app");
+const { ENV/*__DB_IMPORT__*/ } = require("./config");
+const { logger } = require("./utils");
+
+const PORT = ENV.PORT || 3000;
+
+const startServer = async () => {
+  /*__DB_CONNECT__*/
+
+  app.listen(PORT, () => {
+    logger.info("Server", `Server is running on port ${PORT}`);
+  });
+};
+
+startServer().catch((error) => {
+  logger.error("Server", "Failed to start server", error);
+  process.exit(1);
+});

package/template/base/js/src/utils/http-error.js

@@ -0,0 +1,53 @@
+class HttpError extends Error {
+  constructor(status, message) {
+    super(message);
+    this.status = status;
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+class BadRequestError extends HttpError {
+  constructor(message = "Bad Request") {
+    super(400, message);
+  }
+}
+
+class UnauthorizedError extends HttpError {
+  constructor(message = "Unauthorized") {
+    super(401, message);
+  }
+}
+
+class ForbiddenError extends HttpError {
+  constructor(message = "Forbidden") {
+    super(403, message);
+  }
+}
+
+class NotFoundError extends HttpError {
+  constructor(message = "Not Found") {
+    super(404, message);
+  }
+}
+
+class ConflictError extends HttpError {
+  constructor(message = "Conflict") {
+    super(409, message);
+  }
+}
+
+class InternalServerError extends HttpError {
+  constructor(message = "Internal Server Error") {
+    super(500, message);
+  }
+}
+
+module.exports = {
+  HttpError,
+  BadRequestError,
+  UnauthorizedError,
+  ForbiddenError,
+  NotFoundError,
+  ConflictError,
+  InternalServerError,
+};

package/template/base/js/src/utils/index.js

@@ -0,0 +1,22 @@
+const {
+  HttpError,
+  BadRequestError,
+  UnauthorizedError,
+  ForbiddenError,
+  NotFoundError,
+  ConflictError,
+  InternalServerError,
+} = require("./http-error");
+
+const logger = require("./logger");
+
+module.exports = {
+  HttpError,
+  BadRequestError,
+  UnauthorizedError,
+  ForbiddenError,
+  NotFoundError,
+  ConflictError,
+  InternalServerError,
+  logger,
+};

package/template/base/js/src/utils/logger.js

@@ -0,0 +1,67 @@
+const { ENV } = require("../config/env");
+// ANSI color codes for terminal output
+const colors = {
+  reset: "\x1b[0m",
+  blue: "\x1b[34m",
+  cyan: "\x1b[36m",
+  yellow: "\x1b[33m",
+  red: "\x1b[31m",
+  bold: "\x1b[1m",
+};
+
+function format(tag, color) {
+  return `${color}${colors.bold}[${tag}]${colors.reset}`;
+}
+
+function getEnvironment() {
+  return ENV.NODE_ENV === "development" || ENV.NODE_ENV === "staging"
+    ? "development"
+    : ENV.NODE_ENV;
+}
+
+console.log(
+  format("logger", colors.blue),
+  `Logger initialized for ${getEnvironment()} environment.`,
+);
+
+const requiredKeys = ENV && Object.keys(ENV).length ? Object.keys(ENV) : [];
+
+const missing = requiredKeys.filter(
+  (k) => ENV == null || ENV[k] === undefined || ENV[k] === "",
+);
+
+if (missing.length === requiredKeys.length) {
+  console.warn(
+    format("logger", colors.yellow),
+    "ENV values missing — make sure to set up your environment variables correctly.",
+  );
+} else if (missing.length > 0) {
+  console.warn(
+    format("logger", colors.yellow),
+    `Missing ENV keys: ${missing.join(", ")}`,
+  );
+}
+
+const logger = {
+  log(tag, ...args) {
+    if (getEnvironment() !== "development") return;
+    console.log(format(tag, colors.blue), ...args);
+  },
+
+  info(tag, ...args) {
+    if (getEnvironment() !== "development") return;
+    console.info(format(tag, colors.cyan), ...args);
+  },
+
+  warn(tag, ...args) {
+    if (getEnvironment() !== "development") return;
+    console.warn(format(tag, colors.yellow), ...args);
+  },
+
+  error(tag, ...args) {
+    if (getEnvironment() !== "development") return;
+    console.error(format(tag, colors.red), ...args);
+  },
+};
+
+module.exports = logger;

package/template/base/ts/.env.example

@@ -0,0 +1,5 @@
+PORT=4000
+NODE_ENV=development
+/*__ALLOWED_ORIGIN_ENV__*/
+/*__MONGO_URI_ENV__*/
+/*__JWT_SECRET_ENV__*/

package/template/base/ts/.husky/pre-commit

@@ -0,0 +1,13 @@
+set -e
+
+echo "Checking format (prettier)..."
+npm run check-format
+
+echo "Running TypeScript type-check..."
+npx tsc --noEmit
+
+echo "Checking lint..."
+npm run lint -- --max-warnings=0
+
+echo "Building project..."
+npm run build

package/template/base/ts/.prettierignore

@@ -0,0 +1,47 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+.next/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+
+./dist
+
+/*.yml
+/*.yaml
+/*.md
+/*.json
+README.md
+eslint.config.ts

package/template/base/ts/gitignore

@@ -0,0 +1,31 @@
+# Dependencies
+node_modules/
+package-lock.json
+
+# Build output
+dist/
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+
+# ESLint
+.eslintcache
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+

package/template/base/ts/src/app.ts

@@ -0,0 +1,15 @@
+import express from "express";
+import router from "./routes";
+/*__IMPORTS__*/
+
+const app = express();
+
+// Parse JSON request bodies
+app.use(express.json());
+
+/*__MIDDLEWARE__*/
+
+// Connect routes
+app.use(router);
+
+export default app;

package/template/base/{src → ts/src}/config/env.ts

@@ -1,10 +1,10 @@
-import dotenv from "dotenv";
-dotenv.config();
-
-export const ENV = {
-  PORT: process.env.PORT!,
-  /*__ALLOWED_ORIGIN__*/
-  NODE_ENV: process.env.NODE_ENV!,
-  /*__MONGO_URI__*/
-  /*__JWT_SECRET__*/
-};
+import dotenv from "dotenv";
+dotenv.config();
+
+export const ENV = {
+  PORT: process.env.PORT!,
+  /*__ALLOWED_ORIGIN__*/
+  NODE_ENV: process.env.NODE_ENV!,
+  /*__MONGO_URI__*/
+  /*__JWT_SECRET__*/
+};

package/template/base/{src → ts/src}/middlewares/index.ts

@@ -1,3 +1,3 @@
-export { default as methodNotAllowedHandler } from "./method-not-allowed.middleware";
-export { notFound } from "./not-found.middleware";
-export { rootHandler } from "./root.middleware";
+export { default as methodNotAllowedHandler } from "./method-not-allowed.middleware";
+export { notFound } from "./not-found.middleware";
+export { rootHandler } from "./root.middleware";

package/template/base/{src → ts/src}/middlewares/method-not-allowed.middleware.ts

@@ -1,17 +1,16 @@
-// middlewares/methodNotAllowed.ts
-import { Request, Response, NextFunction } from "express";
-
-const methodNotAllowed =
-  (allowedMethods: string[]) => (req: Request, res: Response, next: NextFunction) => {
-    if (!allowedMethods.includes(req.method)) {
-      res.set("Allow", allowedMethods.join(", "));
-      return res.status(405).json({
-        status: "error",
-        message: `Method ${req.method} not allowed for ${req.originalUrl}`,
-        allowed: allowedMethods,
-      });
-    }
-    next();
-  };
-
-export default methodNotAllowed;
+import { Request, Response, NextFunction } from "express";
+
+const methodNotAllowed =
+  (allowedMethods: string[]) => (req: Request, res: Response, next: NextFunction) => {
+    if (!allowedMethods.includes(req.method)) {
+      res.set("Allow", allowedMethods.join(", "));
+      return res.status(405).json({
+        status: "error",
+        message: `Method ${req.method} not allowed for ${req.originalUrl}`,
+        allowed: allowedMethods,
+      });
+    }
+    next();
+  };
+
+export default methodNotAllowed;

package/template/base/{src → ts/src}/middlewares/root.middleware.ts

@@ -1,13 +1,13 @@
 import { Request, Response } from "express";
 
-export const rootHandler = (req: Request, res: Response) => {
+export const rootHandler = (_req: Request, res: Response) => {
   res.json({
     name: "/*__PROJECT_NAME__*/",
     type: "/*__PROJECT_TYPE__*/",
     version: "1.0.0",
     status: "running",
     endpoints: {
-      health: "/v1/health",
+      health: "/api/v1/health",
       /*__AUTH_ENDPOINT__*/
     },
   });

package/template/base/{src → ts/src}/modules/v1/health/health.controller.ts

@@ -1,18 +1,18 @@
-import { Request, Response } from "express";
-import { logger } from "@/utils";
-
-export const healthCheck = async (_: Request, res: Response) => {
-  logger.info("Health", "healthy");
-
-  return res.status(200).json({
-    status: "healthy",
-    uptime: process.uptime(),
-    timestamp: new Date().toISOString(),
-    services: {
-      memory: {
-        rss: process.memoryUsage().rss,
-        heapUsed: process.memoryUsage().heapUsed,
-      },
-    },
-  });
-};
+import { Request, Response } from "express";
+import { logger } from "@/utils";
+
+export const healthCheck = async (_: Request, res: Response) => {
+  logger.info("Health", "healthy");
+
+  return res.status(200).json({
+    status: "healthy",
+    uptime: process.uptime(),
+    timestamp: new Date().toISOString(),
+    services: {
+      memory: {
+        rss: process.memoryUsage().rss,
+        heapUsed: process.memoryUsage().heapUsed,
+      },
+    },
+  });
+};

package/template/base/{src → ts/src}/modules/v1/health/health.route.ts

@@ -1,9 +1,9 @@
-import { Router } from "express";
-import { healthCheck } from "./health.controller";
-import { methodNotAllowedHandler } from "@/middlewares";
-
-const router = Router();
-router.use(methodNotAllowedHandler(["GET"]));
-router.get("/", healthCheck);
-
-export default router;
+import { Router } from "express";
+import { healthCheck } from "./health.controller";
+import { methodNotAllowedHandler } from "@/middlewares";
+
+const router = Router();
+router.use(methodNotAllowedHandler(["GET"]));
+router.get("/", healthCheck);
+
+export default router;

package/template/base/{src → ts/src}/modules/v1/health/index.ts

@@ -1 +1 @@
-export { default as healthRoutes } from "./health.route";
+export { default as healthRoutes } from "./health.route";