create-uk-node-server 1.0.10 → 1.1.0

package/README.md

@@ -57,7 +57,7 @@ your-project/
 
     ```
     APP_ENV=development
-    APP_PORT=3000
+    PORT=3000
     APP_URL=http://localhost:3000
     DB_URL=mongodb://localhost:27017/your-database
     ```

package/bin/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import main from "../index.js";
 main();

package/index.js

@@ -31,9 +31,10 @@ async function main() {
         const pkg = fs.readJsonSync(pkgPath);
         pkg.name = answers.projectName;
         fs.writeJsonSync(pkgPath, pkg, { spaces: 2 });
+        console.log("Installing dependencies...")
         execSync(`cd ${projectPath} && npm install`);
         console.log('success!')
-        console.log(`cd ${answers.projectName} and change DB connection in .env file and run npm start`)
+        console.log(`create .env file and add DB_URL="your-db-connection-string" && run npm start`)
     })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-uk-node-server",
-  "version": "1.0.10",
+  "version": "1.1.0",
   "description": "A CLI tool to quickly scaffold server projects with JavaScript or TypeScript templates",
   "main": "index.js",
   "scripts": {

package/templates/javascript/index.js

@@ -1,18 +1,20 @@
 import express from "express"
-import { connectDB } from "./src/config/db.config.js"
+import dotenv from 'dotenv';
+dotenv.config();
+import indexConfig from "./src/config/index.config.js"
 import indexRoutes from "./src/routes/index.routes.js"
-import { errorHandler } from "./src/middlewares/errorHandler.js"
+import indexMiddleware from "./src/middlewares/index.middleware.js"
 
 const app = express()
-const PORT = 3000
+const PORT = process.env.PORT || 3000;
 
 app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
-app.use(errorHandler);
+app.use(indexMiddleware.errorHandler);
 
 app.use("/api", indexRoutes)
 
-connectDB()
+indexConfig.connectDB()
     .then(() => {
         app.listen(PORT, () => {
             console.log(`Server is running on port ${PORT}`)

package/templates/javascript/src/config/index.config.js

@@ -0,0 +1,5 @@
+import { connectDB } from "./db.config.js"
+
+export default {
+    connectDB
+}

package/templates/javascript/src/middlewares/index.middleware.js

@@ -0,0 +1,5 @@
+import { errorHandler } from "./errorHandler.js"
+
+export default {
+    errorHandler
+}

package/templates/javascript/src/models/index.models.js

@@ -0,0 +1,5 @@
+import User from "./user.model.js"
+
+export default {
+    User
+}

package/templates/javascript/src/routes/index.routes.js

@@ -1,6 +1,6 @@
 import express from "express";
 import { test } from "../controllers/index.controller.js"
-import userRouter from "./uesr.routes.js"
+import userRouter from "./user.routes.js"
 const router = express.Router();
 
 router.get("/test", test);

package/templates/typescript/package.json

@@ -24,5 +24,6 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "type": "module"
 } 

package/templates/typescript/src/config/index.config.ts

@@ -0,0 +1,5 @@
+import { connectDB } from "./db.config.js";
+
+export default {
+    connectDB
+}

package/templates/typescript/src/controllers/index.controller.ts

@@ -0,0 +1,11 @@
+import { Request, Response } from "express";
+import { errorResponse, successResponse } from "../utils/general.js";
+
+export const test = async (req: Request, res: Response) => {
+    try {
+        return res.json(successResponse("Hello from test", {}))
+    } catch (error) {
+        console.log("Error in test--------->", error)
+        return res.json(errorResponse("Something went wrong", error))
+    }
+}

package/templates/typescript/src/index.ts

@@ -1,34 +1,28 @@
 import express from 'express';
 import cors from 'cors';
 import dotenv from 'dotenv';
-import { connectDB } from './utils/db.config.js';
+import indexConfig from './config/index.config.js';
 import indexRoutes from './routes/index.route.js';
+import indexMiddleware from './middlewares/index.middleware.js';
 
 dotenv.config();
 
 const app = express();
-const PORT = process.env.APP_PORT || 3000;
+const PORT = process.env.PORT || 3000;
 
 app.use(cors());
 app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
-
-app.get('/', (req, res) => {
-  res.json({ message: 'Welcome to TypeScript Server!' });
-});
+app.use(indexMiddleware.errorHandler);
 
 app.use('/api', indexRoutes);
 
-const startServer = async () => {
-  try {
-    await connectDB();
-    app.listen(PORT, () => {
-      console.log(`Server is running on port ${PORT}`);
-    });
-  } catch (error) {
-    console.error('Failed to start server:', error);
-    process.exit(1);
-  }
-};
-
-startServer();
+indexConfig.connectDB()
+    .then(() => {
+        app.listen(PORT, () => {
+            console.log(`Server is running on port ${PORT}`)
+        })
+    }).catch((error) => {
+        console.error("Error connecting to MongoDB:", error)
+        process.exit(1)
+    })

package/templates/typescript/src/middlewares/errorHandler.ts

@@ -0,0 +1,9 @@
+import { Request, Response, NextFunction } from "express";
+
+export function errorHandler(err: Error, req: Request, res: Response, next: NextFunction) {
+    res.status(500).json({
+        flag: 0,
+        msg: err.message,
+        data: null
+    })
+}

package/templates/typescript/src/middlewares/index.middleware.ts

@@ -0,0 +1,5 @@
+import { errorHandler } from "./errorHandler.js";
+
+export default {
+    errorHandler
+}

package/templates/typescript/src/models/index.models.ts

@@ -0,0 +1,5 @@
+import User from "./user.model.js"
+
+export default {
+    User
+}

package/templates/typescript/src/routes/index.route.ts

@@ -1,9 +1,10 @@
 import { Router, Request, Response } from 'express';
+import { test} from "../controllers/index.controller.js"
+import userRouter from "./user.routes.js"
 
 const router = Router();
 
-router.get('/', (req: Request, res: Response) => {
-  res.json({ message: 'API is working!' });
-});
+router.get('/', test);
+router.use("/users", userRouter)
 
 export default router; 

package/templates/typescript/src/routes/user.routes.ts

@@ -0,0 +1,11 @@
+import { Router, Request, Response } from "express"
+
+const router = Router()
+
+router.get("/list", (req: Request, res: Response) => {
+    return res.json({
+        message: "users Found Successfully..."
+    })
+})
+
+export default router;

package/createPackageJsonFile.js

@@ -1,60 +0,0 @@
-export default function createPackageJsonFile(projectPath, projectName, language) {
-    let packageJson = `
-{
-  "name": "${projectName}",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "start": "node index.js",
-    "dev": "nodemon index.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "module",
-  "dependencies": {
-    "bcrypt": "^6.0.0",
-    "dotenv": "^16.5.0",
-    "express": "^5.1.0",
-    "mongoose": "^8.15.0",
-    "nodemon": "^3.1.10"
-  }
-}
-    `
-    // if language is typescript
-    if (language === "typescript") {
-        packageJson = `
-{
-    "name": "${projectName}",
-    "version": "1.0.0",
-    "description": "TypeScript server template",
-    "main": "dist/index.js",
-    "scripts": {
-        "start": "node dist/index.js",
-        "dev": "ts-node src/index.ts",
-        "build": "tsc",
-        "watch": "tsc --watch"
-    },
-    "dependencies": {
-        "express": "^4.18.2",
-        "dotenv": "^16.3.1",
-        "cors": "^2.8.5",
-        "mongoose": "^8.0.3"
-    },
-    "devDependencies": {
-        "@types/express": "^4.17.21",
-        "@types/node": "^20.10.0",
-        "@types/cors": "^2.8.17",
-        "typescript": "^5.3.2",
-        "ts-node": "^10.9.1"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "ISC"
-}
-        `
-    }
-    fs.writeFileSync(path.join(projectPath, "package.json"), packageJson)
-}