nrlg is a versatile tool designed to streamline the generation of Node-RED node libraries. With a straightforward command-line interface, it simplifies the setup process, creating a structured template for your projects. Whether you're a seasoned developer or just starting, nrlg makes building and managing your Node-RED nodes easy.
The nrlg project is a powerful tool generator designed to streamline the creation of Node-RED node libraries. Developed by Alessio Pellizzaro from Italy, nrlg simplifies the process of setting up a new Node-RED node library by generating a complete structure with all necessary files and directories.
Key Features
- Automated Project Setup: Quickly generate a foundational framework for your Node-RED library, ensuring that you have all relevant files in place without manual effort.
- Compatible with APXC Template: The tool adheres to the structure outlined in the APXC Template Nodes Library for Node-RED, making it easy for developers familiar with this library to adapt.
Example Usage
To get started with nrlg, simply run the following command in your terminal:
npx nrlg [projectName]
Output Example
Upon execution, nrlg will prompt for details regarding your project. Here’s an example of the output you can expect:
🚀 node-red-apxc-lib-node-gen alias nrlg - v0.0.1
🤖 Tool Generator project for building Node-RED Nodes lib
🧑💻 Developed by Alessio Pellizzaro <alessio.pellizzaro@apserial.it> - Italy
✔ Name of Project? mynodes
✔ Your Name? (nametag) apxc
✔ The number of ports to expose Node-RED on Your System? 1880
✔ Do you have tests? no
📁 Path Created: /mynodes/nodes/input
📁 Path Created: /mynodes/nodes/configs
📁 Path Created: /mynodes/utils
📁 Path Created: /mynodes/examples
📝 File Created: /mynodes/README.md
📝 File Created: /mynodes/.gitignore
📝 File Created: /mynodes/docker-compose.yml
📝 File Created: /mynodes/AUTHORS.txt
📝 File Created: /mynodes/CHANGELOG.md
📝 File Created: /mynodes/package.json
📝 File Created: /mynodes/nodes/configs/my-configs-node.js
📝 File Created: /mynodes/nodes/configs/my-configs-node.html
📝 File Created: /mynodes/nodes/input/my-input-node.js
📝 File Created: /mynodes/nodes/input/my-input-node.html
📝 File Created: /mynodes/utils/support.js
Completed! 😄
Next steps:
cd mynodes
npm install
docker compose up
npm run update
Run make your code! 🚀
Nrlg is an essential tool for developers looking to enhance their Node-RED experience. By automating tedious tasks, it allows you to focus more on creating powerful and efficient Node-RED nodes.