OEKZident.de/ovdashboard
2
0
Fork 0
Code Releases 1 Packages Activity
ovdashboard/ui/README.md

1.9 KiB
Raw Blame History

OVDashboard UI

Quick Start

If you only want a working installation, it is highly recommended to use the docker image on code.yavook.de. The image contains both the API and UI. Refer to the main README 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:

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 - You will probably want to use VSCode with the development container as described above. Alternatively, you can copy the /usr/local/share/ovdashboard_ui/html directory from the docker image:

id=$(docker create code.yavook.de/oekzident.de/ovdashboard:<IMAGE_TAG>)
docker cp "${id}:/usr/local/share/ovdashboard_ui/html" "<LOCAL_PATH>"
docker rm -v "${id}"

Then you can deploy the <LOCAL_PATH> 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 for what can be configured additionally.