Dokumentation hinzugefügt

Luca7255 2024-03-12 12:48:29 +00:00
parent 28e1fb5ab8
commit e7d6178e17
1 changed files with 55 additions and 0 deletions

55
Dokumentation.md Normal file

@ -0,0 +1,55 @@
# Dokumentation zu unserem Projekt
Dies ist die Dokumentation für alle Benutzer
## Leitfaden
* Struktur des Projekts
* Wie bediene ich das denn??
* Änderungen sind Toll! Oder?!
* Nachwort
## Struktur des Projekts
![Grudnstruktur](https://git.ipmake.me/attachments/e2bac67f-a73d-483e-b29f-59bee0ba06f6)
## Wie bediene ich das denn??
_Das Admin Panel zum Verwalten_
Die Admin-Verwaltungsoberfläche bietet verschiedene Funktionen zur Verwaltung von Mitarbeitern und Daten.
1. **Einfügen neuer Mitarbeiter:**
Durch den Plus-Button können neue Mitarbeiter hinzugefügt werden. Dies ermöglicht eine einfache Erweiterung des Mitarbeiterstamms.
2. **Aktualisierung der Daten:**
Ein Pfeil symbolisiert die Option, die Daten zu aktualisieren. Dadurch können alle Informationen auf dem neuesten Stand gehalten werden.
3. **Einfügen von CSV-Dateien:**
Über einen Button in der oberen rechten Ecke können CSV-Dateien hochgeladen und eingefügt werden. Dies erleichtert die Massenaktualisierung oder den Import großer Datensätze.
In der Tabellenansicht haben Administratoren die Möglichkeit, die vorhandenen Datensätze einzusehen und bei Bedarf zu bearbeiten. Darüber hinaus können sie entweder alle Datensätze auf einmal oder einen bestimmten Datensatz selektiv löschen, was eine effiziente Verwaltung der Daten ermöglicht.
**PS:** Falls beim CSV-Import Fehler auftreten werden diese Direkt im Popup angezeigt und der Import abgebrochen.
### _Die Benutzerverwaltung_
- Button "Benutzer erstellen"
- Ermöglicht das Anlegen eines neuen Benutzers
- Zuweisung eines Benutzernamens
- Zuweisung eines Passworts
In der Benutzerverwaltung besteht die Möglichkeit, über den "Benutzer erstellen" Button einen neuen Benutzer anzulegen. Dabei können dem neuen Benutzer ein Benutzername sowie ein Passwort zugewiesen werden. Dies ermöglicht es Administratoren, neue Benutzerkonten mit individuellen Zugangsdaten einfach und effizient zu erstellen.
## Änderungen sind Toll! Oder?!
- Änderungen an Farben und Schriftart
- Code-Anpassung in der Datei "index.tsx" des Webservers
- Einfache Handhabung der Änderungen
- Anpassung der Farben nach individuellem Geschmack
- Anpassung der Schriftart nach persönlicher Präferenz
## Nachwort
Dieses Projekt wurde mit viel Einsatz und Engagement von unserem Team, bestehend aus Niko B, Nils M und Luca R, entwickelt.
Unser Ziel war es, eine benutzerfreundliche und effiziente Plattform zu schaffen. Wir hoffen, dass unsere Dokumentation dabei hilfreich war, das Projekt zu verstehen und effektiv zu nutzen.
Für uns als Team waren Änderungen und Anpassungen ein wichtiger Aspekt, um sicherzustellen, dass das Projekt den Bedürfnissen und Vorlieben unserer Benutzer entspricht. Wir ermutigen Sie daher, Änderungen vorzunehmen, um die Plattform Ihren individuellen Anforderungen anzupassen.
Vielen Dank für Ihr Vertrauen und Ihre Unterstützung!
Mit freundlichen Grüßen,
Niko B, Nils M und Luca R