🚀 MERN Scaffold

A powerful CLI tool to automate the generation of controllers and routes for MERN stack backend models — because scaffolding should be fast and effortless.

---

📦 Local Installation and Usage

1npm i mern-d-scaffold
2npx mern-d-scaffold generate model

📦 Global Installation and usage

1npm install -g mern-d-scaffold
2mern-d-scaffold generate model

⚙️ Prerequisites

• Your project should be using Express and Mongoose.

  npm install express@4.19.0 mongoose@8.3.0
  

Install express-async-handler for proper error handling:

npm install express-async-handler

🛠️ Usage

1. Create a Mongoose Model

Example: models/order.js

1const mongoose = require('mongoose');
2
3const orderSchema = new mongoose.Schema({
4  user: { type: mongoose.Schema.Types.ObjectId, ref: 'User', required: true },
5  totalPrice: { type: Number, required: true },
6  status: { type: String, default: 'pending' },
7});
8
9module.exports = mongoose.model('Order', orderSchema);
10

2. Run the Scaffold CLI

mern-scaffold generate order

This command will:

✅ Check if models/order.js exists
✅ Generate controllers/orderController.js with full CRUD operations
✅ Generate routes/orderRoute.js
✅ Automatically register the route in index.js or server.js

📁 Output Example

controllers/orderController.js

Includes:

• Create Order
  
• Get All Orders
  
• Get Order by ID
  
• Update Order
  
• Delete Order
  

routes/orderRoute.js

• RESTful routes using Express, linked to the controller.

index.js (automatically updated)

1const orderRoutes = require('./routes/orderRoute');
2app.use('/api/orders', orderRoutes);

✨ Features

• 🔧 Auto-generates boilerplate CRUD logic
• 📁 Automatically creates controllers/ and routes/ directories if they don't exist
• 🔌 Dynamically updates main file with new routes
• 🧼 Clean formatting with proper line spacing and comments
• 💻 Cross-platform support (Windows, macOS, Linux)

---

❗ Troubleshooting

Issue	Solution
Model file not found	Ensure models/<model>.js exists before generating
Main file not updated	Rename your main file to index.js or server.js, or manually add route
Missing dependency	Run npm install express-async-handler
Permission issues (Windows)	Run PowerShell as Admin: Start-Process powershell -Verb runAs

---

🧪 Development

1git clone https://github.com/your-username/mern-scaffold.git
2cd mern-scaffold
3npm install
4npm link

After testing, remove the local link:

npm unlink mern-scaffold

License and Author Sections

📜 License

MIT License. See LICENSE for details.

---

👨‍💻 Author

Dilukshan Viyapury

Feel free to contribute or open issues — let's build something awesome together!