"feat: Add: Update documentation and rename scripts for better organization"
This commit is contained in:
@@ -1,6 +1,23 @@
|
||||
# Dokumentation
|
||||
# Dokumentation MYP - Manage your Printer
|
||||
|
||||
Komplikationen:
|
||||
## Projektbeschreibung
|
||||
MYP (Manage your Printer) ist eine Plattform zur Reservierung von 3D-Druckern, die für die TBA im Werk 040, Berlin-Marienfelde, entwickelt wurde.
|
||||
|
||||
## Projektstruktur
|
||||
- `backend/`: Flask-Backend für die API-Anbindung und Datenbankzugriff
|
||||
- `packages/reservation-platform/`: Next.js Frontend für die Benutzeroberfläche
|
||||
- `docs/`: Ausführliche Dokumentationen, Datenbankschema und Diagramme
|
||||
- `scripts/`: Deployment- und Setup-Skripte
|
||||
- `logs/`: Fehlerprotokolle und Logs
|
||||
|
||||
## Umfassende Dokumentation
|
||||
Detaillierte Dokumentationen finden Sie in den folgenden Dateien:
|
||||
- [Technische Dokumentation](docs/README.md)
|
||||
- [Datenbankstruktur](docs/MYP.dbml)
|
||||
- [Aktueller Projektstand](docs/Aktueller%20Stand.md)
|
||||
- [IHK-Dokumentation](docs/Dokumentation_IHK.md)
|
||||
|
||||
## Herausforderungen und Komplikationen
|
||||
- Netzwerkanbindung
|
||||
- Ermitteln der Schnittstellen der Drucker
|
||||
- Auswahl der Anbindung, Entwickeln eines Netzwerkkonzeptes
|
||||
@@ -9,3 +26,15 @@ Komplikationen:
|
||||
- Frontend verstehen lernen
|
||||
- Netzwerk einrichten, Frontend anbinden
|
||||
|
||||
## Verwendete Technologien
|
||||
- Backend: Python, Flask
|
||||
- Frontend: Next.js, React, TypeScript
|
||||
- Datenbank: SQL
|
||||
- Docker für Containerisierung
|
||||
- Raspberry Pi für Druckersteuerung
|
||||
|
||||
## Installation und Einsatz
|
||||
Installation und Einrichtung werden durch die Skripte im Verzeichnis `scripts/` unterstützt.
|
||||
- `scripts/setup/`: Einrichtungsskripte für Backend, Docker und OAuth
|
||||
- `scripts/deployment/`: Bereitstellungsskripte für Raspberry Pi
|
||||
|
||||
|
||||
Reference in New Issue
Block a user