backend-scaffolder 1.0.0

package/README.md

@@ -0,0 +1,164 @@
+# Backend Scaffolder
+
+A simple CLI tool that instantly generates a production-ready Node.js + Express backend folder structure.
+
+## 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
+
+---
+
+## Installation
+
+### Global Installation
+
+```bash
+npm install -g @abdurwebdev/backend-scaffolder
+```
+
+---
+
+## Usage
+
+Create a new backend project:
+
+```bash
+create-backend-layout my-api
+```
+
+If no project name is provided:
+
+```bash
+create-backend-layout
+```
+
+Default folder name:
+
+```bash
+my-backend-app
+```
+
+---
+
+## Generated Structure
+
+```text
+my-api/
+│
+├── logs/
+│
+├── src/
+│   ├── config/
+│   ├── controllers/
+│   ├── middlewares/
+│   ├── models/
+│   ├── routes/
+│   ├── services/
+│   ├── sockets/
+│   └── utils/
+│
+├── server.js
+├── .gitignore
+└── package.json
+```
+
+---
+
+## Generated app.js
+
+```javascript
+const express = require('express');
+const cors = require('cors');
+
+const app = express();
+
+app.use(cors());
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+app.get('/', (req, res) => {
+  res.json({ message: "API is running..." });
+});
+
+module.exports = app;
+```
+
+---
+
+## Getting Started
+
+After generating the project:
+
+```bash
+cd my-api
+npm install
+npm run dev
+```
+
+Server starts on:
+
+```text
+http://localhost:5000
+```
+
+---
+
+## Example
+
+```bash
+create-backend-layout ecommerce-api
+```
+
+Output:
+
+```bash
+🚀 Scaffolding backend structure in:
+ecommerce-api
+
+✅ Structure successfully created!
+
+Next steps:
+cd ecommerce-api
+npm install
+npm run dev
+```
+
+---
+
+## Requirements
+
+* Node.js 18+
+* npm
+
+---
+
+## Author
+
+Abdur Rehman
+
+* GitHub: https://github.com/abdurwebdev
+* LinkedIn: https://www.linkedin.com/in/abdur-rehman-45178a322/
+
+---
+
+## License
+
+ISC

package/index.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+// Get the project name from command line arguments, default to 'my-backend-app'
+const projectName = process.argv[2] || 'my-backend-app';
+const targetDir = path.join(process.cwd(), projectName);
+
+// Define the complete directory structure based on your layout
+const directories = [
+  'logs',
+  'src',
+  'src/config',
+  'src/controllers',
+  'src/middlewares',
+  'src/models',
+  'src/routes',
+  'src/services',
+  'src/sockets',
+  'src/utils',
+];
+
+// Define boilerplate files to generate
+const files = {
+  '.gitignore': `node_modules/\n.env\nlogs/\n.DS_Store`,
+  
+  'server.js': `const app = require('./src/app');\nconst http = require('http');\n\nconst PORT = process.env.PORT || 5000;\nconst server = http.createServer(app);\n\n// Initialize sockets or server listeners here\n\nserver.listen(PORT, () => {\n  console.log(\`Server running on port \${PORT}\`);\n});`,
+  
+  'src/app.js': `const express = require('express');\nconst cors = require('cors');\n\nconst app = express();\n\n// Middlewares\napp.use(cors());\napp.use(express.json());\napp.use(express.urlencoded({ extended: true }));\n\n// Base Route\napp.get('/', (req, res) => {\n  res.json({ message: "API is running..." });\n});\n\nmodule.exports = app;`,
+  
+  'package.json': JSON.stringify({
+    name: projectName,
+    version: "1.0.0",
+    description: "Backend service",
+    main: "server.js",
+    scripts: {
+      start: "node server.js",
+      dev: "nodemon server.js"
+    },
+    dependencies: {
+      express: "^4.19.2",
+      cors: "^2.8.5",
+      dotenv: "^16.4.5"
+    },
+    devDependencies: {
+      nodemon: "^3.1.0"
+    }
+  }, null, 2)
+};
+
+function createScaffold() {
+  console.log(`\n🚀 Scaffolding backend structure in: ${targetDir}...\n`);
+
+  // 1. Create base project directory
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  } else {
+    console.error(`❌ Error: Directory "${projectName}" already exists.`);
+    process.exit(1);
+  }
+
+  // 2. Create subdirectories
+  directories.forEach(dir => {
+    const dirPath = path.join(targetDir, dir);
+    fs.mkdirSync(dirPath, { recursive: true });
+    // Optional: Add a placeholder file so git tracks empty folders
+    fs.writeFileSync(path.join(dirPath, '.gitkeep'), '');
+  });
+
+  // 3. Create starter boilerplate files
+  Object.entries(files).forEach(([filePath, content]) => {
+    const fullPath = path.join(targetDir, filePath);
+    fs.writeFileSync(fullPath, content, 'utf8');
+  });
+
+  console.log(`✅ Structure successfully created!`);
+  console.log(`\nNext steps:\n  cd ${projectName}\n  npm install\n  npm run dev\n`);
+}
+
+createScaffold();

package/npmrc

@@ -0,0 +1 @@
+prefix=${APPDATA}\npm

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "backend-scaffolder",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },"bin": {
+    "create-backend-layout": "./index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": ""
+}