create-prod-backend 1.1.3 → 1.1.4

package/README.md

@@ -1,12 +1,181 @@
-# create-prod-backend 🚀
+# create-prod-backend
 
-CLI tool to generate production-ready backend structure.
+Build a **production-ready Express backend** in seconds — no boilerplate, no setup headaches.
 
-## Usage
+---
+
+##  Installation
 
+Use directly with **npx** (recommended):
+
+```bash
 npx create-prod-backend
+```
+
+Or install globally:
+
+```bash
+npm install -g create-prod-backend
+create-prod-backend
+```
+
+---
 
 ## Features
-- MongoDB setup
-- ENV config
-- Dependency selection
+
+*  Instant Express.js backend setup
+*  Clean and scalable folder structure
+*  Optional MongoDB integration
+*  Environment variable support (.env)
+*  Select dependencies interactively
+*  Production-ready scripts
+*  Developer-friendly CLI
+
+---
+
+## What It Generates
+
+```
+project-name/
+│
+├── src/
+│   ├── controllers/
+│   ├── routes/
+│   ├── models/
+│   ├── middlewares/
+│   ├── utils/
+│   ├── db/
+│   │
+│   ├── app.js
+│   ├── index.js
+│   └── constants.js
+│
+├── public/
+│
+├── .env
+├── .gitignore
+├── package.json
+└── README.md
+```
+
+---
+
+## Usage
+
+Run the CLI:
+
+```bash
+npx create-prod-backend
+```
+
+### You’ll be prompted for:
+
+* Project name
+* MongoDB setup (Yes/No)
+* .env file (Yes/No)
+* Dependencies to install
+* Auto install dependencies
+
+---
+
+## Supported Dependencies
+
+* express
+* nodemon
+* cors
+* bcryptjs
+* dotenv
+* jsonwebtoken
+* cookie-parser
+* cloudinary
+* multer
+* mongoose (optional)
+
+---
+
+## Scripts
+
+After setup:
+
+```bash
+npm run dev     # Development (nodemon)
+npm start       # Production
+```
+
+---
+
+## Example
+
+```bash
+npx create-prod-backend
+
+✔ Enter project name: my-app
+✔ Use MongoDB: Yes
+✔ Use .env: Yes
+✔ Install dependencies: Yes
+```
+
+Your backend is ready!
+
+---
+
+## Tech Stack
+
+* Node.js
+* Express.js
+* MongoDB (optional)
+* Inquirer (CLI prompts)
+* Chalk (CLI styling)
+
+---
+
+## Upcoming Features
+
+* Service layer support
+* Auth template (JWT)
+* Docker setup
+* API documentation (Swagger)
+* TypeScript support
+
+---
+
+## Contributing
+
+Contributions are welcome!
+
+```bash
+git clone https://github.com/codeurge123/create-prod-backend
+cd create-prod-backend
+npm install
+```
+
+---
+
+## License
+
+ISC License
+
+---
+
+## Author
+
+Made by **codeurge316 - @yashbansal**
+
+---
+
+## Support
+
+If you like this project:
+
+* Star the repo
+* Share with others
+* Suggest new features
+
+---
+
+## Final Thought
+
+Stop wasting time setting up backend boilerplate.
+Start building real projects.
+
+- **create-prod-backend** does the setup — you build the product.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-prod-backend",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "A cli tool to generate a production-ready backend boilerplate with Express.js, MongoDB, and essential features.",
   "main": "index.js",
   "bin": {

package/src/services/file.service.js

@@ -44,6 +44,11 @@ export function createFiles(projectPath, answer) {
         fs.writeFileSync(path.join(projectPath, ".env"), envTemplate());
     }
 
+    fs.writeFileSync(
+        path.join(projectPath, "README.md"),
+        `# ${answer.projectName}\n\nGenerated with create-prod-backend CLI.`
+    );
+
     // gitignore
     fs.writeFileSync(
         path.join(projectPath, ".gitignore"),

package/src/services/folder.service.js

@@ -17,7 +17,12 @@ export function createFolders(projectPath) {
     ];
 
     folders.forEach((folder) => {
-        fs.mkdirSync(path.join(projectPath, "src", folder), {
+        const folderPath =
+            folder === "public"
+                ? path.join(projectPath, folder, 'temp') 
+                : path.join(projectPath, "src", folder); 
+
+        fs.mkdirSync(folderPath, {
             recursive: true
         });
     });