search

FlowFuse / node-red-dashboard-2-ui-example

An example project for writing third-party nodes that integrate with Node-RED Dashboard 2.0
Apache License 2.0
3 stars 11 forks source link

readme

Example Node for Node-RED Dashboard

This repository contains an example, third-party, node for the Node-RED Dashboard.

To get started, clone this repository:

# if using HTTPS:
git clone https://github.com/FlowFuse/node-red-dashboard-2-ui-example.git

# if using SSH:
git clone git@github.com:FlowFuse/node-red-dashboard-2-ui-example.git

Then, you can install it's dependencies with:

npm install

Development with Dashboard 2.0

You can read our contribution guide for details on developing your own Dashboard 2.0 integrations & widgets.

This project is intended to be used as a starting point for creating your own custom nodes that can integrate directly with Node-RED Dashboard 2.0.

Note that if you're looking to contribute directly to Node-RED Dashboard 2.0, then use the examples already in the core repository to build on, as they are structured differently to external/third-party widgets.

Architecture

All third-party (non-core) nodes for Node-RED Dashboard 2.0 are structured such that they extend the core ui-template node, and provide access such that you can define custom HTML, CSS, and JavaScript for your widget.