48 lines
1.6 KiB
Markdown
Executable File
48 lines
1.6 KiB
Markdown
Executable File
# Dokumentation MYP - Manage your Printer
|
|
|
|
## 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
|
|
- `frontend/`: 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
|
|
- Beschaffung der Hardware (beschränkte Auswahlmöglichkeiten)
|
|
- Welches Betriebssystem? OpenSuse, NixOS, Debian
|
|
- 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
|