express-modular-monolith 1.0.0

package/README.md

@@ -0,0 +1,14 @@
+# Express Modular Monolith
+
+Generate an Express modular monolith boilerplate.
+
+## Usage
+```bash
+npx express-modular-monolith
+```
+## Features
+
+- JavaScript template
+- TypeScript template
+- Modular monolith structure
+- Express

package/bin/cli.js

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { exec } from "node:child_process";
+import fs from "node:fs/promises";
+import { input, select } from "@inquirer/prompts";
+
+
+const projectName = await input({
+  message: "Project name:"
+});
+
+const language = await select({
+  message: "Choose a language:",
+  choices: [
+    {
+      name: "JavaScript",
+      value: "javascript"
+    },
+    {
+      name: "TypeScript",
+      value: "typescript"
+    }
+  ]
+});
+
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const templatePath = path.join(__dirname, "..", "templates", language);
+
+const projectPath = projectName === "." ? process.cwd() : path.join(process.cwd(), projectName);
+await fs.cp( templatePath, projectPath, { recursive: true });
+
+const packageJsonPath = path.join(projectPath, "package.json");
+
+const packageJson = JSON.parse(
+  await fs.readFile(packageJsonPath, "utf-8")
+);
+
+if (projectName === ".") {
+  packageJson.name = path.basename(process.cwd());
+}else{
+  packageJson.name = projectName;
+}
+
+await fs.writeFile(
+  packageJsonPath,
+  JSON.stringify(packageJson, null, 2)
+);
+
+await exec("npm install", {
+  cwd: projectPath
+})
+
+

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "express-modular-monolith",
+  "version": "1.0.0",
+  "description": "This is a modular monolith project generator for Express.js",
+  "type": "module",
+  "bin": {
+    "express-modular-monolith": "./bin/cli.js"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "author": "Md Khalid Hossain",
+  "dependencies": {
+    "@inquirer/prompts": "^8.6.0"
+  }
+}

package/templates/javascript/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "javascript",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.js",
+  "scripts": {
+    "dev": "node src/server.js"
+  },
+  "dependencies": {
+    "cors": "^2.8.6",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module"
+}

package/templates/javascript/src/app.js

@@ -0,0 +1,8 @@
+import express from 'express'
+
+const app = express()
+
+app.use(express.json())
+app.use(express.urlencoded({ extended: true }))
+
+export default app 

package/templates/javascript/src/common/config/db.js

@@ -0,0 +1 @@
+// write here your database connection code

package/templates/javascript/src/common/utils/apiError.js

@@ -0,0 +1,32 @@
+export class ApiError extends Error {
+    
+    constructor(statusCode, message) {
+        super(message)
+        this.statusCode = statusCode
+        Error.captureStackTrace(this, this.constructor)
+    }
+
+    static badRequest(message = "Bad request") {
+        return new ApiError(400, message);
+    }
+
+    static unauthorized(message = "Unauthorized") {
+        return new ApiError(401, message);
+    }
+    static conflict(message = "Conflict") {
+        return new ApiError(409, message);
+    }
+    static forbidden(message = "forbidden") {
+        return new ApiError(403, message);
+    }
+    static notfound(message = "notfound") {
+        return new ApiError(404, message);
+    }
+    static unprocessable(message = "unprocessable"){
+        return new ApiError(422, message)
+    }
+
+    static internal(message = "Internal Server Error") {
+        return new ApiError(500, message);
+    }
+}

package/templates/javascript/src/common/utils/apiResponse.js

@@ -0,0 +1,26 @@
+export class ApiResponse {
+
+    static ok(res, message, data = null)
+    {
+        return res.status(200).json({
+            success: true,
+            message,
+            data
+        })
+    }
+
+    static created(res, message, data = null)
+    {
+        return res.status(201).json({
+            success: true,
+            message,
+            data
+        })
+    }
+
+    static noContent(res)
+    {
+        return res.status(204).send()
+    }
+    
+}

package/templates/javascript/src/server.js

@@ -0,0 +1,17 @@
+import 'dotenv/config'
+import app from './app.js'
+
+
+const PORT = process.env.PORT || 8000
+
+;(async function start () {
+    try {
+        // execute database connection function here
+        app.listen(PORT, ()=>{
+            console.log(`Server is running at port ${PORT}`)
+        })
+    } catch (error) {
+        console.error('Failed to start server', error)
+        process.exit(1)
+    }
+})()

package/templates/typescript/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "typescript",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.js",
+  "scripts": {
+    "dev": "tsc-watch --onSuccess \"node dist/server.js\""
+  },
+  "dependencies": {
+    "cors": "^2.8.6",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.6",
+    "@types/node": "^25.6.0",
+    "tsc-watch": "^7.2.0",
+    "tsx": "^4.21.0"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module"
+}

package/templates/typescript/src/app.ts

@@ -0,0 +1,7 @@
+import express from 'express'
+import type { Express } from 'express'
+
+
+const app:Express = express()
+
+export default app 

package/templates/typescript/src/common/config/db.ts

@@ -0,0 +1 @@
+// write here your database connection code

package/templates/typescript/src/common/utils/apiError.ts

@@ -0,0 +1,31 @@
+export class ApiError extends Error {
+    constructor(public statusCode: number, message: string) {
+        super(message)
+        this.statusCode = statusCode
+        Error.captureStackTrace(this, this.constructor)
+    }
+
+    static badRequest(message = "Bad request") {
+        return new ApiError(400, message);
+    }
+
+    static unauthorized(message = "Unauthorized") {
+        return new ApiError(401, message);
+    }
+    static conflict(message = "Conflict") {
+        return new ApiError(409, message);
+    }
+    static forbidden(message = "forbidden") {
+        return new ApiError(403, message);
+    }
+    static notfound(message = "notfound") {
+        return new ApiError(404, message);
+    }
+    static unprocessable(message = "unprocessable"){
+        return new ApiError(422, message)
+    }
+
+    static internal(message = "Internal Server Error") {
+        return new ApiError(500, message);
+    }
+}

package/templates/typescript/src/common/utils/apiResponse.ts

@@ -0,0 +1,27 @@
+import type { Response } from "express"
+
+export class ApiResponse {
+    static ok(res:Response, message:string, data: unknown = null)
+    {
+        return res.status(200).json({
+            success: true,
+            message,
+            data
+        })
+    }
+
+    static created(res:Response, message:string, data: unknown = null)
+    {
+        return res.status(201).json({
+            success: true,
+            message,
+            data
+        })
+    }
+
+    static noContent(res:Response)
+    {
+        return res.status(204).send()
+    }
+    
+}

package/templates/typescript/src/server.ts

@@ -0,0 +1,17 @@
+import 'dotenv/config'
+import app from './app.js'
+
+
+const PORT = process.env.PORT || 8000
+
+;(async function start () {
+    try {
+        // execute database connection function here
+        app.listen(PORT, ()=>{
+            console.log(`Server is running at port ${PORT}`)
+        })
+    } catch (error) {
+        console.error('Failed to start server', error)
+        process.exit(1)
+    }
+})()

package/templates/typescript/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}