chore(docs): redid readme + cleanup

2026-02-15 16:23:54 +01:00
parent 61ce5aab3a
commit 7e54800bc3
2 changed files with 38 additions and 201 deletions
--- a/Readme.md
+++ b/Readme.md
@@ -2,124 +2,53 @@

 [![Quality Gate Status](https://sonar.letsstein.de/api/project_badges/measure?project=arbeitszeitmessung&metric=alert_status&token=sqb_253028eff30aff24f32b437cd6c484c511b5c33f)](https://sonar.letsstein.de/dashboard?id=arbeitszeitmessung)

-bis jetzt ein einfaches Backend mit PostgreSQL Datenbank und GO Webserver um Arbeitszeitbuchungen per HTTP PUT einzufügen
+---
+
+Eine open-source Software zur Arbeitszeitmessung
+
+## Features
+
+- manuelle Korrektur von einzelnen Buchungen
+- Buchung von benutzerdefinierten Abwesenheiten
+- automatische gesetzlicher Feiertage
+- Pflege eigener Feiertage
+
+- wöchentliches Abrechnungssystem
+- Kontrolle der Arbeitszeiten durch direkte Führungskraft
+
+- Ausgabe der Arbeitszeiten je Monat in PDF Format
+
+- Anwesenheitsübersicht

 ## Installation

 ```bash
 git clone https://git.letsstein.de/tom/arbeitszeitmessung arbeitszeitmessung

-cd arbeitszeitmessung/Docker
-# .env Datei anpassen
-docker compose up -d
+cd arbeitszeitmessung
+
+./install.sh
 ```

-## PREVIEW
+### Konfiguration:

-Zeitverwaltungsansicht (/time):
-
-![time](docs/images/time.png)
-
-Ansicht der Führungskraft (/team):
-
-![team](docs/images/team.png)
-
-Nutzeransicht (/user):
-
-![user](docs/images/user.png)
-
-## Buchungstypen
-
-1 - Kommen
-2 - Gehen
-3 - Kommen Manuell
-4 - Gehen Manuell
-254 - Automatisch abgemeldet
-
-## API
-
-Nutzung der API
-wenn die `dev-docker-compose.yml` Datei gestartet wird, ist direkt ein SwaggerUI Server mit entsprechender Datei inbegriffen.
-
-### Buchungen [/time]
-
-#### [GET] Anfrage
-
-Parameter: cardID (string)
-Antwort: `200`
-
-```json
-[
-  {
-    "cradID": "test_card",
-    "readerID": "test_reader",
-    "bookingTyp": 2,
-    "loggedTime": "2024-09-05T08:37:53.117641Z",
-    "id": 5
-  },
-  {
-    "cradID": "test_card",
-    "readerID": "mytest",
-    "bookingTyp": 1,
-    "loggedTime": "2024-09-05T08:51:12.670827Z",
-    "id": 6
-  }
-]
-```
-
-Antwort `500`
-Serverfehler
-
-#### [PUT] Anfrage
-
-Parameter: id (int)
-Body: (veränderte Parameter)
-
-```json
-{
-  "cradID": "test_card",
-  "readerID": "mytest",
-  "bookingTyp": 1,
-  "loggedTime": "2024-09-05T08:51:12.670827Z"
-}
-```
-
-Antwort `200`
-
-```json
-{
-  "cradID": "test_card",
-  "readerID": "mytest",
-  "bookingTyp": 1,
-  "loggedTime": "2024-09-05T08:51:12.670827Z",
-  "id": 6
-}
-```
-
-### Neue Buchung [/time/new]
-
-#### [PUT] Anfrage
-
-Parameter:
-
- cardID (string)
- readerID (string)
- bookingType (string)
-
-Antwort `202` Akzeptiert und eingefügt
-
-```json
-{
-  "cradID": "test_card",
-  "readerID": "mytest",
-  "bookingTyp": 1,
-  "loggedTime": "2024-09-05T08:51:12.670827Z",
-  "id": 6
-}
-```
-
-Antwort `409` Konflikt
-Die vorherige Buchung am selben Tag hat den gleichen Buchungstyp
+- Datenbank
+  - `POSTGRES_USER` Postgres ADMIN Nutzername
+  - `POSTGRES_PASSWORD` Postgres ADMIN Passwort
+  - `POSTGRES_API_USER` Postgres API Nutzername für Webanwendung
+  - `POSTGRES_API_PASS` Postgres API Passwort für Webanwendung
+  - `POSTGRES_PATH` Datebank Pfad
+  - `POSTGRES_DB` Postgres Datenbank Name
+  - `POSTGRES_PORT` Postgres Port für administration
+- System
+  - `TZ` Zeitzone
+  - `LOG_LEVEL` Welche Log-Nachrichten werden in der Konsole erscheinen
+- Web/API
+  - `API_TOKEN` API Token für ESP Endpoints
+  - `WEB_PORT` Port unter welchem Webserver erreichbar ist
+- Ordnerstruktur
+  - `BACKUP_FOLDER` Pfad für DB Backup Datein
+  - `LOG_PATH` Pfad für Audit Logs

 # Filestrukture