create-mern-omar 1.0.0 → 1.2.0

package/README.md

@@ -0,0 +1,26 @@
+# create-mern-omar
+
+> A simple CLI generator to quickly scaffold a MERN stack project with Express and Mongoose.
+
+This generator is an opinionated generator that is using express as a framework and mongoose as the ODM.
+
+This generator creates a **ready-to-use backend structure** with the following:
+
+- Express server (`server.js`)
+- MongoDB connection setup (`db/index.js`)  
+- Models folder for Mongoose schemas (`models/`)  
+- Controllers folder for route logic (`controllers/`)  
+- `.env` and `.gitignore` setup
+
+This generator is implemented using **ES Modules** and works as a CLI tool. However the project is using CommonJS
+
+---
+
+## Installation
+
+1. Start your application with the following commands:
+
+```bash
+mkdir project-name
+cd project-name
+npm create mern-omar

package/index.js

@@ -1,37 +1,32 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import fs from "fs";
 import path from "path";
-import url from "url";
+import { fileURLToPath } from "url";
+import { execSync } from "child_process";
 
-/**
- * Absolute path to:
- * - where the user ran the command
- * - NOT where the package lives
- */
-const targetDir = process.cwd();
-
-/**
- * Absolute path to the templates folder
- * (inside your generator package)
- */
-const __filename = url.fileURLToPath(import.meta.url);
+// Resolve __dirname in ES Modules
+const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-const templateDir = path.join(__dirname, "templates");
 
-console.log(`Generating project in: ${targetDir}`);
+const templatesDir = path.join(__dirname, "templates");
+const targetDir = process.cwd();
+
+const renamedFiles = {
+  ".env.example": ".env",
+  ".gitignore.template": ".gitignore"
+};
 
-/**
- * Copy files recursively
- */
+// -------------------------
+// Recursive copy function
+// -------------------------
 function copyRecursive(src, dest) {
-  if (!fs.existsSync(dest)) {
-    fs.mkdirSync(dest, { recursive: true });
-  }
+  if (!fs.existsSync(dest)) fs.mkdirSync(dest, { recursive: true });
 
   for (const item of fs.readdirSync(src)) {
     const srcPath = path.join(src, item);
-    const destPath = path.join(dest, item);
+    const finalName = renamedFiles[item] || item;
+    const destPath = path.join(dest, finalName);
 
     const stat = fs.statSync(srcPath);
 
@@ -39,10 +34,46 @@ function copyRecursive(src, dest) {
       copyRecursive(srcPath, destPath);
     } else {
       fs.copyFileSync(srcPath, destPath);
+      console.log(`Created: ${destPath}`);
     }
   }
 }
 
-copyRecursive(templateDir, targetDir);
+// -------------------------
+// Main generator function
+// -------------------------
+try {
+  console.log("Generating project structure...");
+  copyRecursive(templatesDir, targetDir);
+  console.log("✅ Project files created successfully");
+
+  // Initialize Node.js project
+  console.log("Initializing Node.js project...");
+  execSync("npm init -y", { stdio: "inherit", cwd: targetDir });
 
-console.log("✅ Project structure created!");
+  // Read package.json
+  const pkgPath = path.join(targetDir, "package.json");
+  const pkgJSON = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+
+  // Modify package.json
+  pkgJSON.scripts = {
+    start: "node server.js",
+    dev: "nodemon server.js"
+  };
+  pkgJSON.dependencies = pkgJSON.dependencies || {};
+  pkgJSON.devDependencies = pkgJSON.devDependencies || {};
+  pkgJSON.keywords = ["mern", "express", "mongoose", "generator"];
+
+  // Write back
+  fs.writeFileSync(pkgPath, JSON.stringify(pkgJSON, null, 2));
+  console.log("✅ package.json configured successfully");
+
+  // Install dependencies
+  console.log("Installing dependencies...");
+  execSync("npm install express mongoose dotenv morgan cors", { stdio: "inherit", cwd: targetDir });
+  execSync("npm install --save-dev nodemon", { stdio: "inherit", cwd: targetDir });
+
+  console.log("🚀 Project setup complete! Your Node.js app is ready.");
+} catch (err) {
+  console.error("❌ Error generating project:", err);
+}

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "create-mern-omar",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "type": "module",
   "bin": {
-    "create-express-mongoose": "./index.js"
+    "create-mern-omar": "./index.js"
   },
   "keywords": [
-  "express",
-  "mongoose",
-  "mern",
-  "generator",
-  "scaffold",
-  "cli"
-]
+    "express",
+    "mongoose",
+    "generator",
+    "scaffold",
+    "cli"
+  ]
 }

package/templates/.env.example

@@ -0,0 +1,2 @@
+MONGODB_URI=mongodb://localhost:27017/
+PORT=3000

package/templates/.gitignore.template

@@ -0,0 +1,2 @@
+node_modules    
+.env

package/templates/controllers/index.routes.js

@@ -0,0 +1,10 @@
+const router = require('express').Router()
+
+
+
+router.get('/',(req,res)=>{
+    res.json({messgae:'Success, Your app is up and running'})
+})
+
+
+module.exports = router

package/templates/db/index.js

@@ -1,6 +1,7 @@
 const mongoose = require("mongoose") // importing mongoose
 
 
+const DB_URI = process.env.MONGODB_URI || 'mongodb://localhost:27017/'
 async function conntectToDB(){ //connection to the database
     try{
         await mongoose.connect(process.env.MONGODB_URI)

package/templates/models/User.js

@@ -0,0 +1,26 @@
+const mongoose = require("mongoose");
+
+const userSchema = new mongoose.Schema(
+  {
+    name: {
+      type: String,
+      required: true,
+      trim: true
+    },
+    email: {
+      type: String,
+      required: true,
+      unique: true,
+      lowercase: true
+    },
+    password: {
+      type: String,
+      required: true
+    }
+  },
+  {
+    timestamps: true
+  }
+);
+
+module.exports = mongoose.model("User", userSchema);

package/templates/server.js

@@ -6,8 +6,10 @@ const app = express() // creates a express application
 require("dotenv").config() // allows us to use the .env variables
 const morgan = require("morgan")
 const conntectToDB = require('./db/index')
+const indexRoutes =  require("./controllers/index.routes.js");
+const cors = require('cors')
 
-
+const PORT = process.env.PORT || 3000; // Set port from .env
 
 
 
@@ -33,6 +35,7 @@ conntectToDB() // connect to database
 
 
 // Routes go here
+app.use('/api',indexRoutes)
 
 
 
@@ -45,11 +48,7 @@ conntectToDB() // connect to database
 
 
 
-
-
-
-app.listen(3000,()=>{
-    console.log('App is running on port 3000')
-}) // app will be waiting for requests on port 3000
-
+app.listen(PORT, () => {
+  console.log(`Server is running on port ${PORT}`);
+}); // app will be waiting for requests on port from .env or 3000