node-red-contrib-uibuilder/templates/blank/README.md

Easily create web UI's for Node-RED using any (or no) front-end library. VueJS and bootstrap-vue included but change as desired.

# uibuilder Template: Blank

This is about the simplest template you can get for uibuilder.

It does not use any frameworks and has no other dependencies.

It demonstrates that you can use uibuilder purely with HTML/JavaScript and still easily build a simple, dynamic, data-driven user interface.

All it does is start up uibuilder and will dump any msg you send to it from Node-RED into the browser tab.

## Folders

The root folder contains this file. It can be used for other things **but** it will not be served up in the Node-RED web server.
_Either_ the `src` or the `dist` folder are served up (along with all of their sub-folders). So the root and any other root sub-folders
can be used mostly however you like.

One reserved item in the root folder however will be a `package.json` file. This will be used in the future to help with build/compile steps.
You can still use it yourself, just bear in mind that a future version of uibuilder will make use of the `scripts.build` script.

Two sub-folders are included. The template only has files in the `src` folder.

The `dist` folder will only be used by uibuilder if it contains an `index.html` file.
So if you are using a build (compile) step to produce your production code, ensure that it is configured to use the `dist` folder as the output folder and that it creates the `index.html` file.

Also note that you can use **linked** folders and files in this folder structure. This can be handy if you want to maintain your code in a different folder somewhere or if your default build process needs to use sub-folders other than `src` and `dist`.

## Files

* `index.html`: Contains your basic HTML and will be the file loaded and displayed in the browser when going to the uibuilder defined URL.
* `index.js`: Contains all of the logic for your UI. It must be linked to in the html file.
* `index.css`: Contains your custom CSS for styling. It must be linked to in the html file.

Note that only the `index.html` file is actually _required_. uibuilder will not function as expected without it.

It is possible to use the index.html file simply as a link to other files but it must be present.

The other files are all optional. However, you will need to change the index.html file accordingly if you rename or remove them.