|
1 | 1 | # 🚀 create-node-spark
|
2 | 2 |
|
3 |
| -**The fastest way to scaffold production-ready Node.js backends — no manual setup, no headaches.** |
| 3 | +The fastest way to scaffold production-ready Node.js backends — no manual setup, no headaches. |
4 | 4 |
|
5 | 5 | 
|
6 |
| - |
7 |
| - |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## ✨ Features |
| 12 | + |
| 13 | +✅ **Interactive CLI Setup** |
| 14 | +Answer just **three questions**: |
| 15 | + |
| 16 | +- Enable auth? |
| 17 | +- Enable multer? |
| 18 | +- Enable ESLint? |
| 19 | + → Boom! Your backend is ready. |
| 20 | + |
| 21 | +✅ **Production-Ready Folder Structure** |
| 22 | +No more messy files — get a scalable layout: |
| 23 | + |
| 24 | +```bash my-app/ |
| 25 | +├── src/ |
| 26 | +│ ├── config/ |
| 27 | +│ ├── controllers/ |
| 28 | +│ ├── middleware/ |
| 29 | +│ ├── models/ |
| 30 | +│ ├── routes/ |
| 31 | +│ └── index.js |
| 32 | +├── .env |
| 33 | +├── eslint.config.js (if selected) |
| 34 | +├── package.json (ESM ready) |
| 35 | +└── package-lock.json |
| 36 | +``` |
| 37 | + |
| 38 | +✅ **Auto Installs Key Dependencies** |
| 39 | + |
| 40 | +Sets up: |
| 41 | + |
| 42 | +- Express |
| 43 | +- dotenv |
| 44 | +- jsonwebtoken |
| 45 | +- nodemon (for development) |
| 46 | + |
| 47 | +✅ **ESM Conversion Out of the Box** |
| 48 | +Skip CommonJS headaches — enjoy modern ES modules. |
| 49 | + |
| 50 | +✅ **Multer File Upload Integration** |
| 51 | + → **No more lost files**. Your backend can accept file uploads. |
| 52 | + |
| 53 | +✅ **ESLint Config Generator** |
| 54 | +Auto-generates a clean `eslint.config.js` for code quality. |
| 55 | + |
| 56 | +✅ **Minimal Setup, Maximum Power** |
| 57 | +Stop wasting time on boilerplate — start building immediately. |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +## 📦 Installation |
| 62 | + |
| 63 | +```bash |
| 64 | +npm install -g create-node-spark |
| 65 | +``` |
| 66 | + |
| 67 | +# ⚙️ Usage |
| 68 | + |
| 69 | +```bash |
| 70 | +create-node-spark |
| 71 | +``` |
| 72 | + |
| 73 | +# Use directly (no install) |
| 74 | + |
| 75 | +```bash |
| 76 | +npx create-node-spark |
| 77 | +``` |
| 78 | + |
| 79 | +This will launch the interactive CLI and ask: |
| 80 | + |
| 81 | + porject name : |
| 82 | + |
| 83 | + include auth? (y/n) |
| 84 | + |
| 85 | + include multer? (y/n) |
| 86 | + |
| 87 | + Enable ESLint? (y/n) |
| 88 | + |
| 89 | +After answering, it generates: |
| 90 | + |
| 91 | + A complete folder structure |
| 92 | + |
| 93 | + Installed dependencies |
| 94 | + |
| 95 | + Configured .env and eslint.config.js |
| 96 | + |
| 97 | + ESM-ready package.json |
| 98 | + |
| 99 | +# 🛠 CLI Options |
| 100 | + |
| 101 | +If you prefer non-interactive mode (coming soon), you’ll be able to pass flags like: |
| 102 | + |
| 103 | +```bash |
| 104 | +create-node-spark --auth --monitor --eslint |
| 105 | +``` |
| 106 | + |
| 107 | +**Note: This is planned for future versions!** |
| 108 | + |
| 109 | +# 🤝 Contributing |
| 110 | + |
| 111 | +Contributions, issues, and feature requests are welcome! |
| 112 | +Feel free to check issues or submit a pull request. |
| 113 | + |
| 114 | +- Fork the project |
| 115 | + |
| 116 | +- Create your feature branch (git checkout -b feature/my-feature) |
| 117 | + |
| 118 | +- Commit your changes (git commit -m 'Add awesome feature') |
| 119 | + |
| 120 | +- Push to the branch (git push origin feature/my-feature) |
| 121 | + |
| 122 | +- Open a pull request |
| 123 | + |
| 124 | +# 📄 License |
| 125 | + |
| 126 | +This project is licensed under the MIT License — see the LICENSE file for details. |
| 127 | + |
| 128 | +# 🌟 Show Your Support |
| 129 | + |
| 130 | +If you like this project, please ⭐ star the repo to help others discover it! |
0 commit comments