4bnode 3.5.3 → 4.0.2

package/README.md

@@ -1,194 +1,223 @@
-# 4Brains Node Generator
+# 4bnode
 
-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
+A professional CLI tool and visual dashboard to generate, manage, and test Node.js/Express applications.
 
-### `4bnode init <projectName>`
+Built by [4Brains Technologies](https://4brains.in).
 
-Initialize a new Node.js project with the specified name.
+## Quick Start
 
 ```sh
-4bnode init my-project
+npx 4bnode init my-app
+cd my-app
+npm run dev
 ```
 
-### `4bnode add-api <endpointName>`
+Your app runs at `http://localhost:3000` with a built-in visual dashboard at `http://localhost:3000/_dev`.
 
-Add a new API endpoint to your project.
+## CLI Commands
 
-```sh
-4bnode add-api users
-```
-
-### `4bnode add-mongo`
-
-Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
+### Create a Project
 
 ```sh
-4bnode add-mongo
+npx 4bnode init <name>
 ```
 
-### `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
-```
+Scaffolds a new Express project with:
+- ES Module syntax
+- Environment config (`.env.development`, `.env.production`)
+- CORS, JSON body parser (50MB limit)
+- Static file serving from `public/`
+- Built-in dev dashboard at `/_dev`
 
-### `4bnode add-login`
+### Add Features
 
-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.
+Use the interactive menu:
 
 ```sh
-4bnode add-login
+npx 4bnode add
 ```
 
-### `4bnode add-mongo-insert`
+Or add directly:
+
+| Command | Description |
+|---------|-------------|
+| `4bnode add api <name>` | Create a new API endpoint |
+| `4bnode add mongo` | Configure MongoDB connection |
+| `4bnode add crud` | Add CRUD operations to a route |
+| `4bnode add login` | Add JWT authentication & login |
+| `4bnode add socket` | Integrate Socket.IO |
+| `4bnode add websocket` | Add native WebSocket support |
+| `4bnode add serialport` | Serial port communication |
 
-Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
+### API Endpoint Creation
 
 ```sh
-4bnode add-mongo-insert
+4bnode add api users
 ```
 
-### `4bnode add-mongo-update`
+When creating an API endpoint:
+- Select HTTP method (GET, POST, PUT, DELETE, PATCH)
+- Choose fields from existing model (if available)
+- Add custom fields received from client
+- File fields auto-configure `multer` for multipart uploads
+- All routes use `/api/` prefix
 
-Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
+### Schema Management
 
 ```sh
-4bnode add-mongo-update
+4bnode schema              # Interactive create/view/edit
+4bnode schema user         # Create or edit 'user' schema
 ```
 
-### `4bnode add-mongo-read`
+Supported field types: `String`, `Number`, `Boolean`, `Date`, `Array`, `ObjectId`, `Mixed`, `Buffer`
 
-Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
-
-```sh
-4bnode add-mongo-read
-```
+Field constraints: `required`, `unique`, `default`
 
-### `4bnode add-mongo-delete`
+Presets available: `user`, `product`, `post`
 
-Add a template for deleting data from a MongoDB collection, making it easy to handle deletion operations.
+### List Project Info
 
 ```sh
-4bnode add-mongo-delete
+4bnode list                # Show all models, routes & config
+4bnode list models         # List models only
+4bnode list routes         # List routes only
 ```
 
-### `4bnode add-socket`
+### Dashboard Passkey
 
-Integrate Socket.io into your project for real-time communication capabilities.
+During `npx 4bnode init`, you'll be prompted to set a 6-digit passkey to protect the dev dashboard.
+
+To change the passkey later, run inside your project:
 
 ```sh
-4bnode add-socket
+4bnode passkey
 ```
 
-### `4bnode add-websocket`
-
-Add native WebSocket support to your project.
+### Start Dev Dashboard
 
 ```sh
-4bnode add-websocket
+4bnode ui
 ```
 
-### `4bnode add-serialport`
+Runs `npm run dev` and opens the visual dashboard. Must be run inside a 4bnode project.
 
-Integrate SerialPort functionality into your project. This command does the following:
+## Visual Dashboard
 
-- 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`
+Access at `http://localhost:3000/_dev` when running `npm run dev`.
 
-```sh
-4bnode add-serialport
-```
+### Dashboard Features
 
-Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
+**Overview** - Project status, configured features, quick stats
 
-Example incoming data log:
+**Database** - MongoDB connection setup, URI management
 
-```sh
-Received data: <data from serial device>
-```
+**Schemas** - Create, view, edit MongoDB schemas with field management. Add/remove fields, toggle required/unique, set defaults.
 
-## Examples
+**API Routes** - Full route management:
+- Create new routes (Methods, CRUD, Login, Register)
+- Add methods to existing routes with field selection
+- Select fields from models or add custom fields
+- File upload fields auto-configure multer
+- View route source code, edit inline
+- Share endpoint docs with frontend team (Markdown format)
+- Delete routes (removes file + index.js registration)
 
-### Adding MongoDB Schema
+**API Tester** - Built-in Postman-like API testing tool:
+- REST API, Socket.IO, and WebSocket testing
+- **Body types**: JSON, Form Data, URL Encoded, Raw, Binary
+- **File uploads**: Choose file, send as File or Base64
+- **Auto-detect fields**: Matches URL to route and pre-fills body/form fields from route code
+- **Path variables**: Auto-detects `:id` params, shows editable fields
+- **Query params**: Key-value editor, auto-fills from `req.query`
+- **Headers**: Key-value editor with quick presets (Bearer Auth, JSON, Form Data, URL Encoded, Accept)
+- **Response viewer**: Body + Headers tabs, copy response, save responses
+- **Collection management**: Save requests, organize with responses, delete with confirmation
+- **Share collection**: Generate shareable API documentation page with:
+  - Endpoint details, headers, body fields
+  - Code examples (cURL, Fetch, Axios) with copy button
+  - Form data / file upload code generation
+  - Saved response examples
+  - Search/filter endpoints
+  - Persistent URL (updates on re-share)
+- **Import from routes**: One-click import endpoints from your project routes
+- All data persisted in `.4bnode/` JSON files (not localStorage)
 
-When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
+**Real-time** - Socket.IO and WebSocket configuration
 
-```sh
-4bnode add-mongo-schema User
-```
+**SerialPort** - Serial port setup with path and baud rate config
 
-### Adding a Login Template
+**Environment** - View and edit `.env.development` and `.env.production`
 
-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.
+## Generated Project Structure
 
-```sh
-4bnode add-login
+```
+my-app/
+├── index.js                    # Express app entry point
+├── dev-api.js                  # Dev dashboard API (auto-included)
+├── package.json
+├── .env.development            # Dev environment variables
+├── .env.production             # Production environment variables
+├── .4bnode/                    # Dashboard data (tester, shared collections)
+├── public/                     # Static files
+│   ├── index.html              # Dashboard UI
+│   ├── fonts/
+│   └── images/
+├── uploads/                    # File uploads (when using multer)
+└── src/
+    ├── db.js                   # MongoDB connection (after `add mongo`)
+    ├── models/                 # Mongoose schemas
+    ├── routes/                 # API route files
+    └── middleware/
+        └── auth.js             # JWT auth middleware (after `add login`)
 ```
 
-## Real-time Communication Integration
-
-### WebSocket Integration
+## Real-time Communication
 
-When you add WebSocket integration, it will automatically be added to your project.
+### Socket.IO
 
 ```sh
-4bnode add-websocket
+4bnode add socket
 ```
 
-To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
+Access in routes via `req.io`:
 
 ```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.");
+router.get('/notify', (req, res) => {
+  req.io.emit('message', 'Hello from server');
+  res.json({ sent: true });
 });
 ```
 
-### Socket.io Integration
-
-When you add Socket.io integration, it will automatically be added to your project.
+### WebSocket
 
 ```sh
-4bnode add-socket
+4bnode add websocket
 ```
 
-To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
+Access in routes via `req.wss`:
 
 ```js
-router.get("/some-endpoint", (req, res) => {
-  req.io.emit("message", "Hello, Socket.io clients!");
-  res.send("Message sent to all Socket.io clients.");
+router.get('/broadcast', (req, res) => {
+  req.wss.clients.forEach(client => {
+    if (client.readyState === WebSocket.OPEN) {
+      client.send('Hello from server');
+    }
+  });
+  res.json({ sent: true });
 });
 ```
 
 ## 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
@@ -196,4 +225,10 @@ You can also use `-h` or `--help` to get help information.
 
 ## License
 
-This project is licensed under the ISC License.
+Proprietary License
+
+(c) 2025 4Brains Technologies. All rights reserved.
+
+Unauthorized copying, distribution, modification, or use of this code is strictly prohibited.
+
+For licensing or commercial use: contact@4brains.in