create-uk-node-server 1.0.1 → 1.0.3

package/README.md

@@ -4,7 +4,7 @@ A command-line tool to quickly scaffold server projects with JavaScript or TypeS
 
 ## Installation
 ```bash
-npx create-node-server
+npx create-uk-node-server
 ```
 
 The tool will prompt you to:
@@ -27,16 +27,24 @@ After running the tool, you'll get a project with this structure:
 ```
 your-project/
 ├── src/
+│   ├── config/
+│   │   └── db.config.js
 │   ├── controllers/
+│   │   └── index.controller.js
 │   ├── middlewares/
+│   │   └── errorHandler.js
 │   ├── models/
+│   │   └── user.model.js
 │   ├── routes/
 │   │   └── index.route.js
+│   │   └── user.route.js
 │   └── utils/
-│       ├── db.config.js
 │       └── general.js
-├── package.json
-└── .env
+├── .env
+├── .gitignore
+├── index.js
+├── package-lock.json
+└── package.json
 ```
 
 ## Getting Started
@@ -45,7 +53,7 @@ your-project/
 2. Choose your language preference
 3. Enter your project name
 4. Navigate to your project directory
-5. Update the database connection in the `.env` file
+5. Update DB_URL in `.env` with your database connection string
 6. Run `npm start` to start your server
 
 ## License

package/index.js

@@ -22,17 +22,27 @@ async function main() {
     ]);
 
     const templatePath = path.join(__dirname, "templates", answers.language.toLowerCase());
-    // const projectPath = path.join(__dirname, answers.projectName);
     const projectPath = path.join(process.cwd(), answers.projectName);
 
-    console.log("templatePath--------->", templatePath)
-    console.log("projectPath---------->", projectPath)
-
     fs.copy(templatePath, projectPath, err => {
         if (err) return console.error(err)
         console.log('success!')
     })
 
+    fs.writeFileSync(path.join(projectPath, ".env"), `
+        APP_ENV=development
+        APP_PORT=${process.env.PORT || 3000}
+        APP_URL=http://localhost:${process.env.PORT || 3000}
+        DB_URL=mongodb://localhost:27017/your-database
+    `)
+
+    fs.writeFileSync(path.join(projectPath, ".gitignore"), `
+        .env
+        /node_modules
+        /dist
+        /package-lock.json
+    `)
+
     console.log(`cd ${answers.projectName} and change DB connection in .env file and run npm start`)
 }
 

package/package.json

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

package/templates/javascript/index.js

@@ -1,6 +1,6 @@
 import express from "express"
-import { connectDB } from "./src/utils/db.config.js"
-import indexRoutes from "./src/routes/index.route.js"
+import { connectDB } from "./src/config/db.config.js"
+import indexRoutes from "./src/routes/index.routes.js"
 import { errorHandler } from "./src/middlewares/errorHandler.js"
 
 const app = express()
@@ -10,14 +10,14 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 app.use(errorHandler);
 
+app.use("/api", indexRoutes)
 
-app.use("/", indexRoutes)
-
-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)
-})
+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/javascript/package.json

@@ -19,4 +19,4 @@
     "mongoose": "^8.15.0",
     "nodemon": "^3.1.10"
   }
-}
+}

package/templates/javascript/src/controllers/index.controller.js

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

package/templates/javascript/src/models/user.model.js

@@ -12,15 +12,11 @@ const userSchema = new mongoose.Schema({
     },
     email: {
         type: String,
-        required: true,
-        trim: true,
-        unique: true,
-        lowercase: true,
+        required: true
     },
     password: {
         type: String,
-        required: true,
-        minlength: [8, "Password must be at least 8 characters long"],
+        required: true
     },
     role: {
         type: Number,

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

@@ -0,0 +1,9 @@
+import express from "express";
+import { test } from "../controllers/index.controller.js"
+import userRouter from "./uesr.routes.js"
+const router = express.Router();
+
+router.get("/test", test);
+router.use("/users", userRouter)
+
+export default router;

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

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

package/templates/typescript/src/models/user.model.ts

@@ -3,9 +3,9 @@ import mongoose from "mongoose";
 const userRole = {
     ADMIN: 1,
     USER: 2,
-}
+} as const;
 
-const userSchema = new mongoose.Schema({
+const userSchema = new mongoose.Schema<IUser>({
     name: {
         type: String,
         required: true
@@ -29,5 +29,13 @@ const userSchema = new mongoose.Schema({
     }
 }, { timestamps: true });
 
-const User = mongoose.model("User", userSchema);
+const User: mongoose.Model<IUser> = mongoose.model("User", userSchema);
+
+export interface IUser extends mongoose.Document {
+    name: string;
+    email: string;
+    password: string;
+    role: number;
+}
+
 export default User;

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

@@ -1,8 +0,0 @@
-import express from "express";
-const router = express.Router();
-
-router.get("/", (req, res) => {
-    res.send("Hello World!")
-})
-
-export default router;