node-red

Built by node-red

Wire together devices, APIs and online services in a visual flow editor.

Automation

What it does

Node-RED is a low-code tool for connecting things. Drag nodes onto a canvas, link them together and deploy: an MQTT sensor triggers an HTTP call, a webhook writes to a database, a timer sends a message.

It runs anywhere from a Raspberry Pi to the cloud, and a huge library of community nodes covers almost every service and device.

Highlights

  • Browser-based visual flow editor
  • Thousands of community nodes
  • MQTT, HTTP, WebSocket, TCP and more built in
  • JavaScript function nodes for custom logic
  • Flows saved as JSON, easy to share and reuse

Who it's for

Makers, IoT builders and automation fans who like to see how their logic flows.

from the project's repository

Show the full readme from GitHub

License Build Status

Nodes Flows Collections

Low-code programming for event-driven applications

Forum GitHub Slack

Quick Start

Check out https://nodered.org/docs/getting-started/ for full instructions on getting started.

  1. sudo npm install -g --unsafe-perm node-red
  2. node-red
  3. Open http://localhost:1880

[!NOTE] More documentation can be found here. For further help, or general discussion, please join the Node-RED Forum or Node-RED Slack.

Development

If you want to run the latest code from git, here's how to get started:

  1. Clone the code:

     git clone https://github.com/node-red/node-red.git
     cd node-red
    
  2. Install the node-red dependencies

     npm ci
    
  3. Build the code

     npm run build
    
  4. Run

     npm start
    

Contributing

Before raising a pull-request, please read our contributing guide.

This project adheres to the Contributor Covenant 1.4. By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the project's core team at team@nodered.org.

Contributors

It is maintained by:

Node-RED is a project of the OpenJS Foundation. Copyright OpenJS Foundation and other contributors, https://openjsf.org under the Apache 2.0 license.