diff --git a/README.md b/README.md index 1b3808f..fae736c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_H ![Screenshot](./doc/ovdashboard_en.jpg) + ## Key Features - **Clean Look**
@@ -30,4 +31,15 @@ No static strings anywhere – formats generated using [Luxon](https://momen - **Hackable**
The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library.
-*Like this layout, but want it for something completely different? Fork me!* +*Like my layout, but want it for something completely different? Fork me!* + + +## Quick Start + +Make sure you have a WebDAV and CalDAV server available. +You should start with the `docker` image in any case. + + +## Setup for development and contribution + +Refer to the specific README files for [the API](./api/README.md) and [the UI](./ui/README.md) to contribute to one of those sub-projects. diff --git a/ui/README.md b/ui/README.md index 71debd7..dc96245 100644 --- a/ui/README.md +++ b/ui/README.md @@ -27,6 +27,13 @@ If not, hit `Ctrl+Alt+P` and search for "reopen in container". 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.