backend-scaffolder 1.0.0 → 1.0.3

package/README.md

@@ -1,152 +1,136 @@
-# Backend Scaffolder
+# Backend Scaffolder 🚀
 
-A simple CLI tool that instantly generates a production-ready Node.js + Express backend folder structure.
+Generate a clean and scalable Node.js backend folder structure instantly.
+
+Perfect for developers who are tired of manually creating the same folders and files every time they start a new backend project.
 
 ## Features
 
-* Creates a clean backend architecture
-* Generates common folders:
-
-  * config
-  * controllers
-  * middlewares
-  * models
-  * routes
-  * services
-  * sockets
-  * utils
-* Generates starter files:
-
-  * server.js
-  * app.js
-  * package.json
-  * .gitignore
-* Adds `.gitkeep` files to preserve empty directories
-* Ready for Express development
+✅ Create a production-ready backend structure
 
----
+✅ Save setup time
 
-## Installation
+✅ Consistent project architecture
 
-### Global Installation
+✅ Beginner-friendly
 
-```bash
-npm install -g @abdurwebdev/backend-scaffolder
-```
+✅ Lightweight CLI tool
 
 ---
 
-## Usage
+## Installation
 
-Create a new backend project:
+Install globally:
 
 ```bash
-create-backend-layout my-api
+npm install -g backend-scaffolder
 ```
 
-If no project name is provided:
+Or use directly:
 
 ```bash
-create-backend-layout
+npx backend-scaffolder my-project
 ```
 
-Default folder name:
+---
+
+## Usage
+
+Create a new backend project structure:
 
 ```bash
-my-backend-app
+create-backend-layout my-project
 ```
 
----
-
-## Generated Structure
+This will generate:
 
 ```text
-my-api/
+my-project/
 │
-├── logs/
+├── config/
+├── controllers/
+├── middlewares/
+├── models/
+├── routes/
+├── utils/
+├── views/
 │
-├── src/
-│   ├── config/
-│   ├── controllers/
-│   ├── middlewares/
-│   ├── models/
-│   ├── routes/
-│   ├── services/
-│   ├── sockets/
-│   └── utils/
-│
-├── server.js
-├── .gitignore
-└── package.json
+├── app.js
+├── package.json
+└── .gitignore
 ```
 
 ---
 
-## Generated app.js
-
-```javascript
-const express = require('express');
-const cors = require('cors');
-
-const app = express();
+## Example
 
-app.use(cors());
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
+```bash
+create-backend-layout ecommerce-api
+```
 
-app.get('/', (req, res) => {
-  res.json({ message: "API is running..." });
-});
+Output:
 
-module.exports = app;
+```text
+✔ Creating project structure...
+✔ Creating folders...
+✔ Creating files...
+✔ Project created successfully!
 ```
 
 ---
 
-## Getting Started
+## Why Backend Scaffolder?
 
-After generating the project:
+When starting a new backend project, developers often spend time creating the same folder structure repeatedly.
 
-```bash
-cd my-api
-npm install
-npm run dev
-```
+Backend Scaffolder automates this process so you can focus on building features instead of setting up files.
+
+---
 
-Server starts on:
+## Roadmap
 
-```text
-http://localhost:5000
-```
+- [ ] Express.js template
+- [ ] TypeScript template
+- [ ] MongoDB configuration
+- [ ] JWT Authentication starter
+- [ ] Swagger integration
+- [ ] REST API starter template
+- [ ] MVC architecture presets
 
 ---
 
-## Example
+## Contributing
+
+Contributions are welcome.
+
+1. Fork the repository
+2. Create your feature branch
 
 ```bash
-create-backend-layout ecommerce-api
+git checkout -b feature/amazing-feature
 ```
 
-Output:
+3. Commit your changes
 
 ```bash
-🚀 Scaffolding backend structure in:
-ecommerce-api
+git commit -m "Add amazing feature"
+```
 
-✅ Structure successfully created!
+4. Push to the branch
 
-Next steps:
-cd ecommerce-api
-npm install
-npm run dev
+```bash
+git push origin feature/amazing-feature
 ```
 
+5. Open a Pull Request
+
 ---
 
-## Requirements
+## Issues
+
+Found a bug or have a feature request?
 
-* Node.js 18+
-* npm
+Open an issue on GitHub.
 
 ---
 
@@ -154,11 +138,17 @@ npm run dev
 
 Abdur Rehman
 
-* GitHub: https://github.com/abdurwebdev
-* LinkedIn: https://www.linkedin.com/in/abdur-rehman-45178a322/
+LinkedIn: https://www.linkedin.com/in/abdur-rehman-45178a322
+
+GitHub: https://github.com/abdurwebdev
 
 ---
 
 ## License
 
-ISC
+MIT License
+
+Copyright (c) 2026 Abdur Rehman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files.

package/package.json

@@ -1,14 +1,34 @@
 {
   "name": "backend-scaffolder",
-  "version": "1.0.0",
+  "version": "1.0.3",
+  "description": "CLI tool to generate scalable Node.js backend folder structures instantly.",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },"bin": {
+  "bin": {
     "create-backend-layout": "./index.js"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": ""
+  "keywords": [
+    "backend",
+    "scaffolder",
+    "nodejs",
+    "express",
+    "cli",
+    "generator",
+    "boilerplate",
+    "backend-generator",
+    "mvc",
+    "project-structure"
+  ],
+  "author": "Abdur Rehman",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/abdurwebdev/backend-scaffolder.git"
+  },
+  "bugs": {
+    "url": "https://github.com/abdurwebdev/backend-scaffolder/issues"
+  },
+  "homepage": "https://github.com/abdurwebdev/backend-scaffolder#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  }
 }