create-uk-node-server 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# Server Package CLI
+
+A command-line tool to quickly scaffold server projects with JavaScript or TypeScript templates.
+
+## Installation
+```bash
+npx create-node-server
+```
+
+The tool will prompt you to:
+1. Choose your preferred language (JavaScript or TypeScript)
+2. Enter your project name
+
+## What it does
+
+This tool creates a new server project with:
+- Express.js setup
+- Basic folder structure (controllers, middlewares, models, routes, utils)
+- Database configuration
+- Environment variables setup
+- Basic routing structure
+
+## Project Structure
+
+After running the tool, you'll get a project with this structure:
+
+```
+your-project/
+├── src/
+│   ├── controllers/
+│   ├── middlewares/
+│   ├── models/
+│   ├── routes/
+│   │   └── index.route.js
+│   └── utils/
+│       ├── db.config.js
+│       └── general.js
+├── package.json
+└── .env
+```
+
+## Getting Started
+
+1. Run the CLI tool
+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
+6. Run `npm start` to start your server
+
+## License
+
+ISC
+
+## Contributing
+
+Feel free to submit issues and enhancement requests!

package/bin/cli.js

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

package/index.js

@@ -0,0 +1,39 @@
+import inquirer from "inquirer";
+import path from "path";
+import fs from "fs-extra";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+async function main() {
+    const answers = await inquirer.prompt([
+        {
+            type: "list",
+            name: "language",
+            message: "Choose language",
+            choices: ["Javascript", "Typescript"]
+        },
+        {
+            type: "input",
+            name: "projectName",
+            message: "Enter the name of your project",
+            default: "my-project"
+        }
+    ]);
+
+    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!')
+    })
+
+    console.log(`cd ${answers.projectName} and change DB connection in .env file and run npm start`)
+}
+
+export default main;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "create-uk-node-server",
+  "version": "1.0.0",
+  "description": "A CLI tool to quickly scaffold server projects with JavaScript or TypeScript templates",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node bin/cli.js"
+  },
+  "bin": {
+    "uk-node-server": "bin/cli.js"
+  },
+  "keywords": [
+    "cli",
+    "scaffold",
+    "server",
+    "javascript",
+    "typescript",
+    "express",
+    "boilerplate",
+    "generator"
+  ],
+  "author": "utsav.Karkar",
+  "license": "ISC",
+  "type": "module",
+  "dependencies": {
+    "fs-extra": "^11.3.0",
+    "inquirer": "^12.6.3"
+  }
+}

package/templates/javascript/index.js

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

package/templates/javascript/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "server-setup",
+  "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"
+  }
+}

package/templates/javascript/src/middlewares/errorHandler.js

@@ -0,0 +1,7 @@
+export function errorHandler(err, req, res, next) {
+    res.status(500).json({
+        flag: 0,
+        msg: err.message,
+        data: null
+    })
+}

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

@@ -0,0 +1,33 @@
+import mongoose from "mongoose";
+
+const userRole = {
+    ADMIN: 1,
+    USER: 2,
+}
+
+const userSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: true
+    },
+    email: {
+        type: String,
+        required: true,
+        trim: true,
+        unique: true,
+        lowercase: true,
+    },
+    password: {
+        type: String,
+        required: true,
+        minlength: [8, "Password must be at least 8 characters long"],
+    },
+    role: {
+        type: Number,
+        enum: [userRole.ADMIN, userRole.USER],
+        default: userRole.USER,
+    }
+}, { timestamps: true });
+
+const User = mongoose.model("User", userSchema);
+export default User;

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

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

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

@@ -0,0 +1,13 @@
+import dotenv from 'dotenv'
+dotenv.config()
+import mongoose from 'mongoose'
+
+export const connectDB = async () => {
+    try {
+        await mongoose.connect(process.env.DB_URL)
+        console.log('MongoDB connected successfully')
+    } catch (error) {
+        console.error('Error connecting to MongoDB:', error)
+        process.exit(1)
+    }
+}

package/templates/javascript/src/utils/general.js

@@ -0,0 +1,15 @@
+export const successResponse = (msg, data = {}) => {
+    return {
+        flag: 1,
+        message: msg ?? "Success",
+        data
+    }
+}
+
+export const errorResponse = (msg, data = {}) => {
+    return {
+        flag: 0,
+        message: msg ?? "Something went wrong",
+        data
+    }
+}

package/templates/typescript/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "typescript-server",
+  "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"
+} 

package/templates/typescript/src/index.ts

@@ -0,0 +1,38 @@
+import express from 'express';
+import cors from 'cors';
+import dotenv from 'dotenv';
+import { connectDB } from './utils/db.config';
+
+dotenv.config();
+
+const app = express();
+const PORT = process.env.APP_PORT || 3000;
+
+// Middleware
+app.use(cors());
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+// Routes
+app.get('/', (req, res) => {
+  res.json({ message: 'Welcome to TypeScript Server!' });
+});
+
+// Import routes
+import indexRoutes from './routes/index.route';
+app.use('/api', indexRoutes);
+
+// Start server
+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(); 

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

@@ -0,0 +1,33 @@
+import mongoose from "mongoose";
+
+const userRole = {
+    ADMIN: 1,
+    USER: 2,
+}
+
+const userSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: true
+    },
+    email: {
+        type: String,
+        required: true,
+        trim: true,
+        unique: true,
+        lowercase: true,
+    },
+    password: {
+        type: String,
+        required: true,
+        minlength: [8, "Password must be at least 8 characters long"],
+    },
+    role: {
+        type: Number,
+        enum: [userRole.ADMIN, userRole.USER],
+        default: userRole.USER,
+    }
+}, { timestamps: true });
+
+const User = mongoose.model("User", userSchema);
+export default User;

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

@@ -0,0 +1,9 @@
+import { Router, Request, Response } from 'express';
+
+const router = Router();
+
+router.get('/', (req: Request, res: Response) => {
+  res.json({ message: 'API is working!' });
+});
+
+export default router; 

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

@@ -0,0 +1,12 @@
+import mongoose from 'mongoose';
+
+export const connectDB = async (): Promise<void> => {
+  try {
+    const mongoURI = process.env.DB_URL || 'mongodb://localhost:27017/your-database';
+    await mongoose.connect(mongoURI);
+    console.log('MongoDB connected successfully');
+  } catch (error) {
+    console.error('MongoDB connection error:', error);
+    process.exit(1);
+  }
+}; 

package/templates/typescript/src/utils/general.ts

@@ -0,0 +1,19 @@
+export const formatDate = (date: Date): string => {
+  return date.toISOString();
+};
+
+export const successResponse = (msg: string, data: any) => {
+  return {
+    flag: 1,
+    msg: msg ?? "Success",
+    data: data ?? null
+  }
+}
+
+export const errorResponse = (msg: string, data: any) => {
+  return {
+    flag: 0,
+    msg: msg ?? "Something went wrong",
+    data: data ?? null
+  }
+}

package/templates/typescript/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true, 
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}