nodered-node-incubator v0.1.1
Node-RED Project Incubator :egg:
Install :zap:
To install the CLI tool, execute the following command:
npm install -g nodered-node-incubator
Usage :rocket:
Once installed, you can use the tool with by executing the node-inq
command:
node-inq --help
Usage: node-inq [options] [command]
Nodes Project Incubator for Node-RED πΌπ¦
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
generate [options] Node-RED project generation tool
nodes Node-RED incubated nodes tool
help [command] display help for command
Generating Projects :package:
To generate a new Node-RED project execute the following commmand:
node-inq generate --help
Usage: node-inq generate [options]
Generate Node-RED node project template π₯
Options:
-i,--interactive Enable interactive mode (default: false)
-p, --project <directory> Project directory
-l, --license <type> Project license (default: "MIT")
-ts, --typescript Generate typescript project (default: false)
-e, --example Import example node (default: false)
-h, --help display help for command
Interactive :baby_chick:
It is highly recommened to use interactive mode
to help you in the project generation process. Following is an example running the command:
node-inq generate --interactive
β Enter project directory: ... node-red-contrib-example-project
β Enter project author: ... Doth-J
β Enter project description: ... Node-RED node generation example
β Enter project license: ... ISC
β Generate Typescript project: ... yes
β Import template node: ... yes
π₯ Generating Node-RED project:
- Directory: /home/doth/node-red-contrib-example-project βοΈ
- Language set to "Typescript" βοΈ
- Created nodes directory! βοΈ
- Created "package.json"! βοΈ
- Imported example node! π£
π Node-RED Incubator setup:
- Installed required modules! βοΈ
- Created incubator server βοΈ
π Typescript setup:
- Installed required ts modules! βοΈ
- Created "tsconfig.json"! βοΈ
β
All done, project generated!
π Let the Flow be with you
Command Line :scroll:
To use the command line tool, you only need to define the project
option with the directory of the project as shown below:
node-inq generate --project ./example-project
π₯ Generating Node-RED node project:
- Directory: /home/doth/example-project βοΈ
- Language set to "Javascript" βοΈ
- Created nodes directory! βοΈ
- Created "package.json"! βοΈ
π Node-RED Incubator setup:
- Installed required modules! βοΈ
- Created incubator server βοΈ
β
All done, project generated!
π Let the Flow be with you
Importing Incubated Nodes :hatching_chick:
To import incubated nodes, execute the following command:
node-inq nodes
β Enter project directory: ... example-project
β Available nodes list: Β» Multi-out, Template, Topic
π£ Importing incubated Node-RED node(s):
- Imported multi-out node! π₯
- Imported example node! π₯
- Imported topic node! π₯
Incubator Server :baby_bottle:
The tool creates an incubator
folder containing a minimal Node-RED setup to get you started.
Execute the following command to spin up your incubator server and fast track the development of your nodes:
npm run dev
Change the setting.js
file accordingly to your project needs.