Skip to content

Commit

Permalink
Merge pull request #313 from TotallyInformation/v7.0.0
Browse files Browse the repository at this point in the history
V7.0.0 - scans checked and resolved. 325 commits, 244 files changed. 12,598 total lines of code (22,400 including comments).
  • Loading branch information
TotallyInformation committed Sep 1, 2024
2 parents da35335 + 5982df6 commit 657390b
Show file tree
Hide file tree
Showing 244 changed files with 20,730 additions and 26,072 deletions.
11 changes: 1 addition & 10 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ module.exports = {
'plugin:sonarjs/recommended',
// 'plugin:prettier/recommended',
// The n plugin reads the min. node.js version from package.json and error's any ES features not available in that version.
// https://www.npmjs.com/package/eslint-plugin-n#-rules
'plugin:n/recommended',
],
// settings: {
Expand All @@ -84,16 +85,6 @@ module.exports = {
rules: {
'n/no-process-exit': 'error',

// remove once min engines moves to node.js v14+
// 'es/no-optional-chaining': 'error',
// 'es/no-dynamic-import': 'error',
// 'es/no-nullish-coalescing-operators': 'error',

// remove once min engines moves to node.js v15+
'es/no-logical-assignment-operators': 'error',
'es/no-promise-any': 'error',
'es/no-numeric-separators': 'error',

// Tidy up some jsdoc oddities
'jsdoc/multiline-blocks': 0,
'jsdoc/newline-after-description': 0,
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 🆕 Request a feature
description: File a bug/issue on the core of Node-RED
description: Request for something new or improved
labels: [needs-triage]
body:
- type: markdown
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Node.JS |
npm |
Node-RED |
uibuilder node |
uibuilderFE |
uibuilder client library |
OS |
Browser |

12 changes: 4 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,10 @@ docs/.obsidian/snippets/attention-callout.css
docs/.obsidian/themes/Minimal/manifest.json
docs/.obsidian/themes/Minimal/theme.css

# Omit random test files.
tests/execa/package-lock.json
tests/execa/package.json
tests/execa/test-execa-src.js
tests/execa/test-execa-src.mjs
tests/execa/test-execa.js
tests/execa/test2.mjs
tests/execa/test3.js
# We don't need the lock file for Node-RED nodes
package-lock.json

#
tmp/_*
docs/docs.md
docs/.config/doctest.md
6 changes: 6 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.github/
.vscode/
node_modules/
tmp/
tests/
archive/
1,221 changes: 309 additions & 912 deletions CHANGELOG.md

Large diffs are not rendered by default.

24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ UIBUILDER for Node-RED allows the easy creation of data-driven front-end web app

It includes many helper features that can reduce or eliminate the need to write code for building data-driven web applications and user interfaces integrated with Node-RED.

> [!NOTE]
> UIBUILDER triggers a quality warning in the [Flows scorecard entry](https://flows.nodered.org/node/node-red-contrib-uibuilder/scorecard).
>
> "Number of Dependencies" is >6 - this is due to the large number of features in UIBUILDER and is expected. Even so, v7 only has 7 dependencies. 1 more is due to be removed in a future release.
## Installation

UIBUILDER is best installed using Node-RED's Palette Manager.
Expand All @@ -35,18 +40,18 @@ cd ~/.node-red
npm install node-red-contrib-uibuilder
```

To install old versions:
To install old versions, provide the major version number:

```bash
cd ~/.node-red
npm install node-red-contrib-uibuilder@v5.1.1
npm install node-red-contrib-uibuilder@v5
```

To install development branches, please install from [GitHub](https://github.com/TotallyInformation/node-red-contrib-uibuilder):
To install development branches, please install from [GitHub](https://github.com/TotallyInformation/node-red-contrib-uibuilder). Branchnames are future version numbers, check GitHub for available branches:

```bash
cd ~/.node-red
npm install totallyinformation/node-red-contrib-uibuilder#branchname
npm install totallyinformation/node-red-contrib-uibuilder#v7.1.0
```

You will need to restart Node-RED if installing manually.
Expand All @@ -56,17 +61,16 @@ You will need to restart Node-RED if installing manually.

The current [CHANGELOG](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/CHANGELOG.md) contains all of the changes and requirement details for each version.

Older changes can be found in the previous change documents: [CHANGELOG-V5](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v5.md), [CHANGELOG-V3/V4]([/docs](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/)/CHANGELOG-v3-v4.md), [CHANGELOG-v2](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v2.md), and [CHANGELOG-v2](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v1.md)
Older changes can be found in the previous change documents: [CHANGELOG-V5](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v6.md), [CHANGELOG-V5](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v5.md), [CHANGELOG-V3/V4]([/docs](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/)/CHANGELOG-v3-v4.md), [CHANGELOG-v2](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v2.md), and [CHANGELOG-v2](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/archived/CHANGELOG-v1.md).

## Getting started

Once installed, The following is a typical simple flow to get going.

1. Add a `uibuilder` node. Open its settings and give it a "URL" which is used as the identifying name. Close the settings and click on the Deploy button.
2. Add an inject node for some simple input data and two debug nodes on the two output ports so that you can see everything that is going on. Deploy the flow.
3. Re-open the `uibuilder` node's settings and click the "Open" button to see the resulting web page.
2. Re-open the `uibuilder` node's settings and click the "Open" button to see the resulting web page.

You are now ready to edit the front-end html/javascript/css if you wish and to add logic in Node-RED to provide inputs and handle outputs.
You are now ready to edit the front-end html/javascript/css if you wish and to add logic in Node-RED to provide inputs and handle outputs. You can also use UIBUILDER's no-code features to create your UI as well or instead.

Please see the [First-timers walkthrough](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/walkthrough1) in the documentation and the [Introduction Video](https://www.youtube.com/watch?v=IVWR_3cx05A) for more help to get started. Also try out the built-in example flows.

Expand Down Expand Up @@ -228,6 +232,10 @@ You can also support the development of UIBUILDER by sponsoring the development.
[GitHub Sponsorship](https://github.com/sponsors/TotallyInformation),
[PayPal Sponsorship](https://paypal.me/TotallyInformation)

## Sponsors

- [@MagicJF](https://github.com/MagicJF)

## Developers/Contributors

- [Julian Knight](https://github.com/TotallyInformation) - the designer and main author.
Expand Down
Loading

0 comments on commit 657390b

Please sign in to comment.