2022-09-21 23:46:09 +00:00
# OVDashboard
A fancy dashboard for use in a [THW ](https://en.wikipedia.org/wiki/Technisches_Hilfswerk )-Ortsverband (OV).
2022-09-27 19:59:27 +00:00
2022-09-21 23:46:09 +00:00
## Key Features
- **Clean Look** < br />
All that matters, at one glance! < br / >
2022-09-27 17:58:22 +00:00
*Date and Time – Upcoming Events – Public Announcements – News – Pictures*
2022-09-21 23:46:09 +00:00
- **Easy Install** < br />
Set up a RaspberryPi, run the [installer script ](TODO ), done!
- **DAV Server Interface** < br />
Update your content anytime, from anywhere!
Basic [Markdown ](https://www.markdownguide.org/ ) is enough! < br />
Already have a [Nextcloud ](https://nextcloud.com/ ) instance?
OVDashboard will take it from there!
- **Customizable – Yet Always Recognizable** < br />
Change the Logo – Put your own Title – Publish Pictures – Create Event Lists – Customize the News Ticker Appearance – Adjust Item Rotation Speed
- **Responsive Design** < br />
2022-09-21 23:50:18 +00:00
OVDashboard is made for the big screen – but it also shines in your visitors' mobile browsers!
2022-09-21 23:46:09 +00:00
- **Locale Aware** < br />
2022-09-21 23:50:18 +00:00
No static strings anywhere – formats generated using [Luxon ](https://moment.github.io/luxon/#/ ), which [respects your browsers' settings ](./doc/ovdashboard_de.jpg )!
2022-09-21 23:46:09 +00:00
- **Hackable** < br />
The Dashboard UI is created using [Vue ](https://vuejs.org/ ) and the [Vuetify ](https://vuetifyjs.com/ ) UI library. < br />
2022-09-27 19:59:27 +00:00
*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.
