# create-mern-boiler-app

[![npm version](https://img.shields.io/npm/v/create-mern-boiler-app.svg)](https://www.npmjs.com/package/create-mern-boiler-app)
[![npm downloads](https://img.shields.io/npm/dm/create-mern-boiler-app.svg)](https://www.npmjs.com/package/create-mern-boiler-app)
[![license](https://img.shields.io/npm/l/create-mern-boiler-app.svg)](LICENSE)

A **MERN stack boilerplate generator** to quickly scaffold a full-stack project with **MongoDB, Express, React, and Node.js**.  
It sets up the **project structure**, installs dependencies, configures **API routes, frontend routing, and developer tools** so you can focus on building features instead of repetitive setup. 🚀  

---

## 👨‍💻 Author

**Nikhil Tiwari**  
[![GitHub](https://img.shields.io/badge/GitHub-black?logo=github)](https://github.com/nikhilhuh)

---

## 🙏 Mentor / Guidance

**Debasish Sahoo**  
[![GitHub](https://img.shields.io/badge/GitHub-black?logo=github)](https://github.com/debasishsahoo)

---

## ✨ Features

- ⚡ **One-command project scaffolding**  
- 🗂️ Pre-configured **backend** (Express + MongoDB with Mongoose)  
- 🎨 Ready-to-use **React frontend** with routing  
- 📦 Clean & modular **folder structure** for API + frontend  
- 🔧 Developer tools: ESLint, Prettier, Nodemon, Concurrently  
- 🌍 Environment-based configuration with `.env`  
- 🔌 Optional **Tailwind CSS** & **Socket.IO** setup  
- ✅ Production-ready build scripts  

---

## 📦 Installation & Usage

Install via npm:

```bash
npx create-mern-boiler-app
```

You’ll be guided with prompts:

```bash
🚀 Welcome to Create MERN App

? Project name: <your_project_name> 
? Choose language: 
❯ TypeScript
  JavaScript
? Include Tailwind CSS (frontend)? (y/N)
? Include Socket.io? (y/N)
⠼ Installing dependencies... (this may take a while)
✔ Project setup complete! 🎉

Next steps:

  cd my-mern-app
  cd frontend && npm run dev
  cd backend && npm run dev
```

Frontend: http://localhost:5173
Backend: http://localhost:4000

---

## 🏗️ Project Structure

```bash
my-mern-app/
├── backend/        # Express + MongoDB backend
│   ├── configs/
│   ├── middleware/
│   ├──models/
│   ├── routes/
│   ├── utils/
│   ├──app.js
│   └── server.js
│
├── frontend/       # React frontend
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── routes/
│   │   ├── services/
│   │   └── App.jsx
│   │   ├── index.css/
│   │   ├── main.jsx/
│   └── package.json
│
├── .gitignore 
└── README.md
```

---

## License

MIT © 2025 Nikhil Tiwari