Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flowfuse/node-red-dashboard-2-ui-example
An example project for writing third-party nodes that integrate with Node-RED Dashboard 2.0
https://github.com/flowfuse/node-red-dashboard-2-ui-example
Last synced: about 2 months ago
JSON representation
An example project for writing third-party nodes that integrate with Node-RED Dashboard 2.0
- Host: GitHub
- URL: https://github.com/flowfuse/node-red-dashboard-2-ui-example
- Owner: FlowFuse
- License: apache-2.0
- Created: 2023-09-29T08:44:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-14T10:38:30.000Z (7 months ago)
- Last Synced: 2024-06-14T11:57:52.780Z (7 months ago)
- Language: Vue
- Size: 117 KB
- Stars: 2
- Watchers: 4
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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:
```bash
# if using HTTPS:
git clone https://github.com/FlowFuse/node-red-dashboard-2-ui-example.git
# if using SSH:
git clone [email protected]:FlowFuse/node-red-dashboard-2-ui-example.git
```
Then, you can install it's dependencies with:
```bash
npm install
```
## Development with Dashboard 2.0
You can read our [contribution guide](https://dashboard.flowfuse.com/contributing/widgets/third-party.html) 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](https://github.com/FlowFuse/flowforge-nr-dashboard).
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.