ovdashboard/ui/README.md

# OVDashboard UI


## Quick Start

If you only want a working installation, it is highly recommended to use the `docker` image at [`TODO`](TODO).
The image contains both the API and UI.
Refer to the [main README](../README.md) for an in-depth how-to.


## Setup for development and contribution

No need to fiddle around with specific Node.js versions.
You only need a "general purpose" development setup to get this project up and running for debug and contribution purposes:

- [Docker Engine](https://docs.docker.com/engine/install/)
- [Visual Studio Code](https://code.visualstudio.com/)
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension)

Once you open this directory in VSCode, you should be prompted to reopen it in a development container.
If not, hit `Ctrl+Alt+P` and search for "reopen in container".


## Running the UI without the `docker` image

> You probably don't need this! Usually the image is good enough!

However, if you want to deploy the UI on a cluster or any custom web server, go ahead.
First, run `yarn build` in this directory - I'd recommend you use VSCode with a development container as described above.
Alternatively, you can copy the `/html` directory from the `docker` image:

```sh
id=$(docker create TODO)
docker cp "${id}:/html" "/path/to/dist"
docker rm -v "${id}"
```

Then you can deploy the `dist` directory as the webroot using your favourite web server.


## Configuration

The OVDashboard UI is created using Vue.js. Even though the default config should fit most applications, you can refer to the [Configuration Reference](https://cli.vuejs.org/config/) for what can be configured additionally.