45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
# OVDashboard
|
|
|
|
A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_Hilfswerk)-Ortsverband (OV).
|
|
|
|
|
|
|
|
|
|
## Key Features
|
|
|
|
- **Clean Look** <br />
|
|
All that matters, at one glance! <br />
|
|
*Date and Time – Upcoming Events – Public Announcements – News – Pictures*
|
|
|
|
- **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 />
|
|
OVDashboard is made for the big screen – but it also shines in your visitors' mobile browsers!
|
|
|
|
- **Locale Aware** <br />
|
|
No static strings anywhere – formats generated using [Luxon](https://moment.github.io/luxon/#/), which [respects your browsers' settings](./doc/ovdashboard_de.jpg)!
|
|
|
|
- **Hackable** <br />
|
|
The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br />
|
|
*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.
|