Files
3D-Organizer/README.md
2026-09-07 08:19:41 +02:00

73 lines
2.3 KiB
Markdown

# 3D Project Manager
Eine kleine Docker-basierte Webanwendung, um 3D-Druck-Projekte zu verwalten:
Projekte anlegen, STL-/3MF-Dateien per Drag & Drop hochladen und direkt im
Browser als 3D-Vorschau betrachten.
## Setup
1. `.env.example` nach `.env` kopieren und `PROJECTS_DIR` auf einen Ordner
auf deiner Festplatte setzen, z. B.:
```
PROJECTS_DIR=/home/deinname/3d-projects
```
Das ist der Ordner, in dem deine Projekte als normale Unterordner
angelegt werden — den kannst du auch direkt im Dateimanager oder Slicer
öffnen.
2. Container bauen und starten:
```
docker compose up --build -d
```
3. Im Browser öffnen: [http://localhost:8080](http://localhost:8080)
## Wie es funktioniert
- **Projekt anlegen** → im Container wird `PROJECTS_DIR/<Projektname>`
erstellt (durch den Bind-Mount landet das direkt auf deiner Platte).
- **Dateien hochladen** → per Drag & Drop oder Klick auf die Upload-Fläche,
nur `.stl` und `.3mf` werden akzeptiert. Sie werden 1:1 in den
Projektordner kopiert.
- **3D-Vorschau** → beim Öffnen eines Projekts wird für jede Datei ein
eigener Three.js-Viewer (mit Zoom/Rotation per Maus) im Grid angezeigt.
- **App-Einstellungen/Metadaten** liegen ausschließlich im
`app-settings`-Docker-Volume, nicht in deinem Projektordner. Aktuell
benötigt die App noch keine eigene Konfiguration, aber der Ordner ist für
spätere Erweiterungen (z. B. Nutzerverwaltung) bereits vorbereitet.
## Projektstruktur auf der Festplatte
```
<PROJECTS_DIR>/
Gehäuse-Prototyp/
deckel.stl
boden.3mf
Ersatzteil/
halterung.stl
```
Reine Ordner mit deinen Dateien — du kannst sie auch außerhalb der App
öffnen, kopieren oder in deinen Slicer ziehen. Lösch- und Umbenennungen
über den Dateimanager wirken sich beim nächsten Laden der Seite ebenfalls
auf die App aus.
## Bekannte Grenzen (erster Wurf)
- Single-User, kein Login.
- Projekt-/Dateinamen sind auf Buchstaben, Zahlen, Leerzeichen, `-` und `_`
beschränkt (Schutz gegen Pfad-Tricks).
- Kein Undo beim Löschen — es wird aber vorher immer nachgefragt.
## Stack
- Backend: FastAPI (Python), liefert API + statische Frontend-Dateien aus
einem einzigen Container.
- Frontend: reines HTML/CSS/JS, 3D-Rendering mit Three.js (STLLoader /
3MFLoader) via CDN.
- Docker Compose mit Bind-Mount für Projekte und separatem Volume für
App-Settings.