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

README files

Browse source
This commit is contained in:
Jörn-Michael Miehe 2022-09-27 19:59:27 +00:00
parent 2c88caead9
commit 044e2a351e
2 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,6 +4,7 @@ A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_H
![Screenshot](./doc/ovdashboard_en.jpg) ![Screenshot](./doc/ovdashboard_en.jpg)
## Key Features ## Key Features
- **Clean Look** <br /> - **Clean Look** <br />
@ -30,4 +31,15 @@ No static strings anywhere &ndash; formats generated using [Luxon](https://momen
- **Hackable** <br /> - **Hackable** <br />
The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br /> The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br />
*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.

7
ui/README.md
View file

@ -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. 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. 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. Then you can deploy the `dist` directory as the webroot using your favourite web server.