4bnode 1.1.1 → 3.5.2

package/README.md

@@ -1,116 +1,106 @@
-# 4Brains Node Tool
+# 4Brains Node Generator
 
-A professional tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
+A comprehensive CLI tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
 
-## Usage via NPX
+## Installation
 
-No global installation needed.
-
-Run any command using `npx`:
-
-```sh
-npx 4bnode <command>
-```
-
-Examples:
+To install the 4Brains Node Generator globally, use the following command:
 
 ```sh
-npx 4bnode init my-project
-npx 4bnode add-mongo
-npx 4bnode add-serialport
+npm install -g 4brains-node-generator
 ```
 
 ## Available Commands
 
-### `npx 4bnode init <projectName>`
+### `node-app init <projectName>`
 
 Initialize a new Node.js project with the specified name.
 
 ```sh
-npx 4bnode init my-project
+node-app init my-project
 ```
 
-### `npx 4bnode add-api <endpointName>`
+### `node-app add-api <endpointName>`
 
 Add a new API endpoint to your project.
 
 ```sh
-npx 4bnode add-api users
+node-app add-api users
 ```
 
-### `npx 4bnode add-mongo`
+### `node-app add-mongo`
 
 Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
 
 ```sh
-npx 4bnode add-mongo
+node-app add-mongo
 ```
 
-### `npx 4bnode add-mongo-schema <schemaName>`
+### `node-app add-mongo-schema <schemaName>`
 
 Create a new MongoDB schema. You will be prompted to enter field details for the schema.
 
 ```sh
-npx 4bnode add-mongo-schema User
+node-app add-mongo-schema User
 ```
 
-### `npx 4bnode add-login`
+### `node-app add-login`
 
 Add a login template to an existing route in your project. You will be prompted to select a route and a model, and then enter the login fields.
 
 ```sh
-npx 4bnode add-login
+node-app add-login
 ```
 
-### `npx 4bnode add-mongo-insert`
+### `node-app add-mongo-insert`
 
 Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
 
 ```sh
-npx 4bnode add-mongo-insert
+node-app add-mongo-insert
 ```
 
-### `npx 4bnode add-mongo-update`
+### `node-app add-mongo-update`
 
 Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
 
 ```sh
-npx 4bnode add-mongo-update
+node-app add-mongo-update
 ```
 
-### `npx 4bnode add-mongo-read`
+### `node-app add-mongo-read`
 
 Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
 
 ```sh
-npx 4bnode add-mongo-read
+node-app add-mongo-read
 ```
 
-### `npx 4bnode add-mongo-delete`
+### `node-app add-mongo-delete`
 
 Add a template for deleting data from a MongoDB collection, making it easy to handle deletion operations.
 
 ```sh
-npx 4bnode add-mongo-delete
+node-app add-mongo-delete
 ```
 
-### `npx 4bnode add-socket`
+### `node-app add-socket`
 
 Integrate Socket.io into your project for real-time communication capabilities.
 
 ```sh
-npx 4bnode add-socket
+node-app add-socket
 ```
 
-### `npx 4bnode add-websocket`
+### `node-app add-websocket`
 
 Add native WebSocket support to your project.
 
 ```sh
-npx 4bnode add-websocket
+node-app add-websocket
 ```
 
-### `npx 4bnode add-serialport`
+### `node-app add-serialport`
 
 Integrate SerialPort functionality into your project. This command does the following:
 
@@ -120,7 +110,7 @@ Integrate SerialPort functionality into your project. This command does the foll
 - Installs required dependencies: `serialport` and `@serialport/parser-readline`
 
 ```sh
-npx 4bnode add-serialport
+node-app add-serialport
 ```
 
 Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
@@ -138,7 +128,7 @@ Received data: <data from serial device>
 When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
 
 ```sh
-npx 4bnode add-mongo-schema User
+node-app add-mongo-schema User
 ```
 
 ### Adding a Login Template
@@ -146,7 +136,7 @@ npx 4bnode add-mongo-schema User
 When you run the command to add a login template, you will be prompted to select a route and a model, and then enter the login fields.
 
 ```sh
-npx 4bnode add-login
+node-app add-login
 ```
 
 ## Real-time Communication Integration
@@ -156,7 +146,7 @@ npx 4bnode add-login
 When you add WebSocket integration, it will automatically be added to your project.
 
 ```sh
-npx 4bnode add-websocket
+node-app add-websocket
 ```
 
 To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
@@ -177,7 +167,7 @@ router.get("/some-endpoint", (req, res) => {
 When you add Socket.io integration, it will automatically be added to your project.
 
 ```sh
-npx 4bnode add-socket
+node-app add-socket
 ```
 
 To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
@@ -200,18 +190,10 @@ Unknown command. Use -h or --help for help.
 You can also use `-h` or `--help` to get help information.
 
 ```sh
-npx 4bnode -h
-npx 4bnode --help
+node-app -h
+node-app --help
 ```
 
 ## License
 
-Proprietary License
-
-© 2025 4Brains Technologies. All rights reserved.
-
-This software is proprietary and confidential. Unauthorized copying, distribution, modification, or use of this code, in whole or in part, is strictly prohibited.
-
-The contents of this package may not be used for any purpose without the express written permission of 4Brains Technologies.
-
-For licensing or commercial use inquiries, contact: contact@4brains.in
+This project is licensed under the ISC License.

package/README_4bnode.md

@@ -0,0 +1,197 @@
+# 4Brains Node Generator
+
+A comprehensive CLI tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
+
+## Installation
+
+To install the 4Brains Node Generator globally, use the following command:
+
+```sh
+npm install -g 4brains-node-generator
+```
+
+## Available Commands
+
+### `4bnode init <projectName>`
+
+Initialize a new Node.js project with the specified name.
+
+```sh
+4bnode init my-project
+```
+
+### `4bnode add-api <endpointName>`
+
+Add a new API endpoint to your project.
+
+```sh
+4bnode add-api users
+```
+
+### `4bnode add-mongo`
+
+Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
+
+```sh
+4bnode add-mongo
+```
+
+### `4bnode add-mongo-schema <schemaName>`
+
+Create a new MongoDB schema. You will be prompted to enter field details for the schema.
+
+```sh
+4bnode add-mongo-schema User
+```
+
+### `4bnode add-login`
+
+Add a login template to an existing route in your project. You will be prompted to select a route and a model, and then enter the login fields.
+
+```sh
+4bnode add-login
+```
+
+### `4bnode add-mongo-insert`
+
+Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
+
+```sh
+4bnode add-mongo-insert
+```
+
+### `4bnode add-mongo-update`
+
+Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
+
+```sh
+4bnode add-mongo-update
+```
+
+### `4bnode add-mongo-read`
+
+Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
+
+```sh
+4bnode add-mongo-read
+```
+
+### `4bnode add-mongo-delete`
+
+Add a template for deleting data from a MongoDB collection, making it easy to handle deletion operations.
+
+```sh
+4bnode add-mongo-delete
+```
+
+### `4bnode add-socket`
+
+Integrate Socket.io into your project for real-time communication capabilities.
+
+```sh
+4bnode add-socket
+```
+
+### `4bnode add-websocket`
+
+Add native WebSocket support to your project.
+
+```sh
+4bnode add-websocket
+```
+
+### `4bnode add-serialport`
+
+Integrate SerialPort functionality into your project. This command does the following:
+- Prompts for Serial Port path and baud rate
+- Automatically updates `.env.development` and `.env.production` with `SERIALPORT_PATH` and `BAUDRATE`
+- Adds SerialPort and Readline parser setup to your `index.js`
+- Installs required dependencies: `serialport` and `@serialport/parser-readline`
+
+```sh
+4bnode add-serialport
+```
+
+Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
+
+Example incoming data log:
+```sh
+Received data: <data from serial device>
+```
+
+## Examples
+
+### Adding MongoDB Schema
+
+When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
+
+```sh
+4bnode add-mongo-schema User
+```
+
+### Adding a Login Template
+
+When you run the command to add a login template, you will be prompted to select a route and a model, and then enter the login fields.
+
+```sh
+4bnode add-login
+```
+
+## Real-time Communication Integration
+
+### WebSocket Integration
+
+When you add WebSocket integration, it will automatically be added to your project.
+
+```sh
+4bnode add-websocket
+```
+
+To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
+
+```js
+router.get("/some-endpoint", (req, res) => {
+  req.wss.clients.forEach((client) => {
+    if (client.readyState === WebSocket.OPEN) {
+      client.send("Hello, client!");
+    }
+  });
+  res.send("Message sent to all WebSocket clients.");
+});
+```
+
+### Socket.io Integration
+
+When you add Socket.io integration, it will automatically be added to your project.
+
+```sh
+4bnode add-socket
+```
+
+To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
+
+```js
+router.get("/some-endpoint", (req, res) => {
+  req.io.emit("message", "Hello, Socket.io clients!");
+  res.send("Message sent to all Socket.io clients.");
+});
+```
+
+## Help
+
+If you enter an invalid command, you will see the following message:
+
+```sh
+Unknown command. Use -h or --help for help.
+```
+
+You can also use `-h` or `--help` to get help information.
+
+```sh
+4bnode -h
+4bnode --help
+```
+
+## License
+
+This project is licensed under the ISC License.

package/index.js

@@ -78,7 +78,7 @@ function checkMongoConfig() {
 function showHelp() {
   console.log(
     chalk.green(`
-Usage: ${chalk.bold("4bnode <command> [options]")}
+Usage: ${chalk.bold("node-app <command> [options]")}
 
 Commands:
   ${chalk.blue(
@@ -120,13 +120,13 @@ const param = args[1];
 
 if (command === "init") {
   if (!param) {
-    console.error(chalk.red("Usage: 4bnode init <projectName>"));
+    console.error(chalk.red("Usage: node-app init <projectName>"));
     process.exit(1);
   }
   createSkeletonApp(param);
 } else if (command === "add-api") {
   if (!param) {
-    console.error(chalk.red("Usage: 4bnode add-api <endpointName>"));
+    console.error(chalk.red("Usage: node-app add-api <endpointName>"));
     process.exit(1);
   }
   execSync(`node ${path.join(__dirname, "add-api.js")} ${param}`, {
@@ -146,13 +146,13 @@ if (command === "init") {
   });
 } else if (command === "add-mongo-schema") {
   if (!param) {
-    console.error(chalk.red("Usage: 4bnode add-mongo-schema <schemaName>"));
+    console.error(chalk.red("Usage: node-app add-mongo-schema <schemaName>"));
     process.exit(1);
   }
   if (!checkMongoConfig()) {
     console.error(
       chalk.red(
-        "MongoDB is not configured. Please run '4bnode add-mongo' first."
+        "MongoDB is not configured. Please run 'node-app add-mongo' first."
       )
     );
     process.exit(1);

package/package.json

@@ -1,18 +1,28 @@
 {
   "name": "4bnode",
-  "version": "1.1.1",
-  "description": "A professional tool to generate a Node.js app by 4Brains Technologies",
+  "version": "3.5.2",
+  "description": "A CLI tool to generate a Node.js app by 4Brains Technologies",
   "main": "index.js",
   "type": "module",
   "bin": {
-    "4bnode": "index.js"
+    "4bnode": "index.js",
+    "add-api": "add-api.js",
+    "add-mongo": "add-mongo.js",
+    "add-socket": "add-socket.js",
+    "add-websocket": "add-websocket.js",
+    "add-mongo-schema": "add-mongo-schema.js",
+    "add-login": "add-login.js",
+    "add-mongo-insert": "add-mongo-insert.js",
+    "add-mongo-update": "add-mongo-update.js",
+    "add-mongo-read": "add-mongo-read.js",
+    "add-mongo-delete": "add-mongo-delete.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pawan-4brains/4bnode"
+    "url": "https://github.com/pawan-4brains/4brains-node-generator"
   },
   "keywords": [
     "node",
@@ -23,8 +33,8 @@
     "Node.js skeleton"
   ],
   "author": "4Brains",
-  "license": "Proprietary",
+  "license": "ISC",
   "dependencies": {
-    "chalk": "^5.4.1"
+    "chalk": "^5.3.0"
   }
 }

package/skeleton/package.json

@@ -8,12 +8,12 @@
     "dev": "nodemon index.js"
   },
   "dependencies": {
-    "express": "^5.1.0",
-    "dotenv": "^16.5.0",
-    "body-parser": "^2.2.0",
+    "express": "^4.19.2",
+    "dotenv": "^16.4.5",
+    "body-parser": "^1.20.2",
     "cors": "^2.8.5"
   },
   "devDependencies": {
-    "nodemon": "^3.1.10"
+    "nodemon": "^3.1.3"
   }
 }

package/test-server/package.json

@@ -8,13 +8,13 @@
     "dev": "nodemon index.js"
   },
   "dependencies": {
-    "body-parser": "^2.2.0",
+    "body-parser": "^1.20.2",
     "cors": "^2.8.5",
-    "dotenv": "^16.5.0",
-    "express": "^5.1.0",
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
     "ws": "^8.18.2"
   },
   "devDependencies": {
-    "nodemon": "^3.1.10"
+    "nodemon": "^3.1.3"
   }
 }