added readme doc

This commit is contained in:
Elmar Kresse
2024-09-09 12:02:01 +02:00
parent 00009f7bfe
commit da203167a9

46
documentation/readme.adoc Normal file
View File

@ -0,0 +1,46 @@
= HTWKalender-PWA
== Beschreibung
Die HTWKalender-PWA ist eine Progressive Web App, die es ermöglicht, den Stundenplan der Hochschule für Technik, Wirtschaft und Kultur Leipzig anzuzeigen. Die App wurde im Rahmen des Moduls "Progressive Web Apps" im Studiengang Informationstechnik an der HTWK Leipzig entwickelt. Sie ist als Fork vom Projekt "HTWKalender" entstanden.
Dabei sind spezielle Funktionen für die Offline-Nutzung und die Installation auf mobilen Geräten hinzugekommen.
// Gliederung
== Technologien
Die HTWKalender-PWA wurde mit folgenden Technologien entwickelt:
* Vue.js - Web Framework
* PrimeVue - Component Library
* Vite - Build Tool
* Vite-Plugin-PWA - Plugin für PWA-Funktionalitäten
* TypeScript
// Gliederung
== Features
Die HTWKalender-PWA bietet folgende Features:
* vite pwa plugin
* [line-through]#push notifications for upcoming events#
* semi offline room finder
* offline calendar ical viewer
* [line-through]#async calendar edit#
* setup development server for pwa deployment
* service worker for caching feed
* popup informations in ical viewer
* popup for "copy to clipborad" is difficult to read
* settings page
* setup default page
* fix shadow in ical viewer
* screenshots with "form_factor" set to "wide" pwa installation
* share api for room occupation/calendar
* app version in settings and update notification