Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to reflect latest project status #521

Merged
merged 5 commits into from
Jan 25, 2024
Merged

Update README to reflect latest project status #521

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ade7a6
Update README to reflect latest project status
joepavitt Jan 25, 2024
dc3383e
Use alternative image for the template example
joepavitt Jan 25, 2024
11a54b1
Update README.md
joepavitt Jan 25, 2024
376dc68
Update README.md
joepavitt Jan 25, 2024
80255f4
s/that's/those are
joepavitt Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 38 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Documentation can be found here: https://dashboard.flowfuse.com

## Motivation

The original [Node-RED Dashboard](https://github.com/node-red/node-red-dashboard) has served us well for many years, providing an intuitive way to create live dashboards for Node-RED flows. However, the original Dashboard is based on Angular v1, which is no longer actively maintained. We identified the need for a secure, updated, and innovative successor.

Node-RED Dashboard 2.0 was re-built from the ground up, learning from the popular features and feedback of Node-RED Dashboard 1.0. It will carry the legacy forward, adapting to future needs while keeping the essence of open-source and community-driven development intact. The project will is licensed under Apache 2.0.

## Installation

FlowFuse's Node-RED Dashboard 2.0 is available in the Node-RED Palette Manager. To install it:
Expand All @@ -18,35 +24,52 @@ If you want to use `npm` to install your nodes, you can instead [follow these in

*Note*: this package was previously published under the name `@flowforge/node-red-dashboard`. That package has now been deprecated and will not receive any further updates.

## Contributing
## Features

If you would like to run this set of nodes locally, and specifically to help contribute to the development efforts, you can read the [Contributing](https://dashboard.flowfuse.com/contributing/) documentation.
Node-RED Dashboard 2.0 provides a base set of nodes for building your own user interfaces and data visualisations. Much like it's predecessor, it provides a set of easy-to-use, core nodes, but provides complete flexibility for customisation and control over theming, layout and behaviour if you want to go further.

# Dashboard Planning Repository
### Easy Integration

Welcome to the Node-RED Dashboard 2.0 repository. This repository is currently under construction, but we are working diligently to bring you a modern, interactive data visualization and dashboard solution for Node-RED.
The nodes provided integrate seamlessly with any of the existing nodes and flows you have. Whatever you're trying to control or visualise, you can do it with Node-RED and Node-RED Dashboard 2.0.

## Motivation
### Data Visualization

<img width="600" alt="Example of data visualisations in Dashboard 2.0" src="https://github.com/FlowFuse/node-red-dashboard/assets/99246719/48da3687-bebd-4e2a-88b5-6abe2af4fc46">

No dashboard is complete without data visualisation. Node-RED Dashboard 2.0 provides a core `ui-chart` widget to provide a simple, yet powerful way to visualise your data. It supports a wide range of chart types, including line, bar and scatter, with more planned for the near future.

### Flexible Customisation

<img width="600" alt="Example of a dashboard using custom templates to render a to-do list" src="https://github.com/FlowFuse/node-red-dashboard/assets/99246719/10d2b81b-8dfe-4597-84c8-03c1776287d5">

As with Dashboard 1.0, the new Dashboard 2.0, comes with a `ui-template` node which allows you to define your own custom widgets and styling.

It provides a framework with which you can write raw HTML/JavaScript, define an entire Vue component to render something truly unique and interactive, and override _any_ of the styling of the dashboard using your own custom CSS declarations.

If you're looking to build your own bespoke templates, checkout our useful [UI Template Examples](https://dashboard.flowfuse.com/user/template-examples.html) collection

### Complete Control

The Node-RED Dashboard has served us well for many years, providing an intuitive way to create live dashboards for Node-RED flows. However, the original Dashboard is based on Angular v1, which is no longer actively maintained. We identified the need for a secure, updated, and innovative successor. Hence, we are embarking on this journey.
`ui-event` and `ui-control` both allow rich insight into interactivity with your dashboard, as well as easy to use control over the dashboard itself, allowing you to dynamically hide and disable content, driven by any criteria of your choosing.

## Solution
### Build with Markdown & Mermaid

The new Node-RED Dashboard will be published as a separate package. It will carry the legacy forward, adapting to future needs while keeping the essence of open-source and community-driven development intact. The project will be licensed under Apache 2.0.
The new `ui-markdown` widget allows you to build rich, interactive applications using [Markdown](https://www.markdownguide.org/) and [Mermaid Charts](https://mermaid.js.org/). You can use Markdown templates to build your UI, and populate it with your own, dynamic data, and then use Mermaid to display dynamic charts and diagrams.

## Community and Contribution
## Project Planning

We strongly believe in the power of community. If you have suggestions, feedback, or features you'd like to see, please open a [Github issue](https://github.com/FlowFuse/node-red-dashboard/issues/new/choose). We also highly encourage open-source contributions. We aim to create a robust tool through community collaboration.
### Community and Contribution

## Join Us
As an open-source project, Node-RED Dashboard 2.0 openly welcomes all forms of contributions, whether those are ideas, bug reports, or code contributions through Pull Requests.

We're looking for a freelancer to assist in the development of the first version of the new dashboard. This 2-3 month project offers an opportunity to shape the future of data visualization and Node-RED. Interested? [Contact us](https://boards.greenhouse.io/flowforge).
We strongly believe in the power of community. If you have suggestions, feedback, or features you'd like to see, please open a [Github issue](https://github.com/FlowFuse/node-red-dashboard/issues/new/choose). We also highly encourage open-source contributions.

## Vision
### Roadmap

We are excited about the potential of this project. The journey is filled with challenges, but with the support of the community and a dedicated team, we're confident in creating a tool that surpasses its predecessor.
We are constantly reviewing the priority of our backlog, and have multiple public project management boards where you can keep an eye on what we're working on, and what's coming up next:

Join us on this journey as we redefine the future of data visualization with the new Node-RED Dashboard.
- [Activity Tracker](https://github.com/orgs/FlowFuse/projects/15/views/1): See what's being actively worked on, what's up next, and if there are any "Blocked" items you could help with.
- [Dashboard 1.0 Feature Parity](https://github.com/orgs/FlowFuse/projects/15/views/5): We haven't quite yet achieved 100% feature parity with the original Node-RED Dashboard, and this board tracks the progress and priority of those features.

## License

Expand Down
Loading