node-red-node-template

KO | EN

gitlite — search

#python #react #llm #android #machine-learning #deep-learning #linux #macos #nodejs #java #awesome-list #pytorch #ios #openai

node-red-node-template

(★ 9)

No description available.

node-red-node-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Node generator / template for Node-RED

This repository provides a starting point (a generator with templates) for writing custom nodes
for [Node-RED](https://nodered.org/) using TypeScript and ES6 classes instead of bare Javascript.
It also makes an effort to automate away a lot of boilerplate for the packaging up your node, as
well as enabling easy testing with [VSCode Dev Containers](https://code.visualstudio.com/docs/remote/create-dev-container).

See [Why pick me](#why-pick-me) for more of what this particular generator has to offer.

## Make a node
So you want to build a node? It's Super Easy&trade;.

### Dependencies
* Docker (Docker Desktop on Windows is fine, but it must be running in WSL2 mode.)

### Quick start

**Note**: These steps will walk you through creating a basic package called *bobs-iot-devices*. Obviously, change that
to something to better reflect what you want to build. (Don't put *node-red-* in front of the name though except
where specified.)

1. Fork this repo and clone it.  
    `git clone https://github.com/<your-username-here>/<your-repo-here>.git`
    * Name it something to do with the node(s) you're going to create, e.g. `node-red-bobs-iot-devices`.
    * (You don't strictly need to fork if you just want to do local development. If that's the case, just clone this repo directly.)

2. Start up VSCode and open your newly cloned folder.
    * (On Windows, I start with the folder in a WSL window `Command Palette -> Remote-WSL: New WSL Window`.
       I'm not certain that's necessary unless you've cloned the repo in the WSL filesystem, but I tend to do it that way.)

3. Restart in a Dev Container. You may get prompted to do this automatically. If not:  
   `Command Palette -> Remote Containers: Open Workspace in Container`

* **Here's where the good stuff starts!**

4. Generate the basic `package.json` and `tsconfig.json`.
    ```sh
    ./generate.js generate packageJson -name "bobs-iot-devices" -author "Your Name <your@email.here>"
    ```
    * For more arguments to `./generate.js`, see [Generator syntax](#generator-syntax) or just run `./generate.js`
    with no arguments

5. Generate your first node!
    ```sh
    ./generate.js generate node -name "bobs-sensor"
    ```
    * This will populate a folder `bobs-iot-devices` with `views`, `locales`, and `icons`.
    * If you want to generate another node, just run the command with a second name.

6. Compile everything. You can either do it:
    * via the GUI: `Command Palette -> Run Task -> Compile TS` or 
    * in the terminal: `npm run compile:all`

7. Launch Node-RED!
    * `Run -> Start Debugging`

8. Check out your new node at [http://localhost:1880](http://localhost:1880)! Look for "Some Node" at the bottom of the Node-RED palette.

### Customizing your node

There are a few files that get created for each node that you will want to change to do anything interesting.  
(Replace `bobs-iot-devices` and `bobs-sensor` with your package and node name.)

### Generator syntax
TODO

## Why pick me?
* VSCode Dev Container support:
    * Test locally! Iterate often!
* Full-featured TypeScript support:
    * For both the backend node _and_  the frontend JS.
* Generate and publish a hello world node without writing any code!
* Views rendered from separate HTML, TypeScript, and Markdown/HTML (for help) files so syntax highlighting "just works."
* Template tests! (Coming soon...)
* Watch/auto-build (Coming soon...)

node-red-node-template

node-red-node-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

node-red-node-template

node-red-node-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README