4bnode 1.0.0

package/README.md

@@ -0,0 +1,199 @@
+# 4Brains Node CLI
+
+A comprehensive CLI tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
+
+## Installation
+
+To install the 4Brains Node CLI globally, use the following command:
+
+```sh
+npm install -g 4bnode
+```
+
+## 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/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/README_final_4bnode.md

@@ -0,0 +1,199 @@
+# 4Brains Node CLI
+
+A comprehensive CLI tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
+
+## Installation
+
+To install the 4Brains Node CLI globally, use the following command:
+
+```sh
+npm install -g 4bnode
+```
+
+## 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.