ovdashboard/README.md
2022-10-08 02:44:29 +02:00

1.7 KiB
Raw Blame History

OVDashboard

A fancy dashboard for use in a THW-Ortsverband (OV).

Screenshot

Key Features

  • Clean Look
    All that matters, at one glance!
    Date and Time Upcoming Events Public Announcements News Pictures

  • Easy Install
    Set up a RaspberryPi, run the installer script, done!

  • DAV Server Interface
    Update your content anytime, from anywhere! Basic Markdown is enough!
    Already have a Nextcloud instance? OVDashboard will take it from there!

  • Customizable Yet Always Recognizable
    Change the Logo Put your own Title Publish Pictures Create Event Lists Customize the News Ticker Appearance Adjust Item Rotation Speed

  • Responsive Design
    OVDashboard is made for the big screen but it also shines in your visitors' mobile browsers!

  • Locale Aware
    No static strings anywhere formats generated using Luxon, which respects your browsers' settings!

  • Hackable
    The Dashboard UI is created using Vue and the Vuetify UI library.
    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 and the UI to contribute to one of those sub-projects.