Initial commit mit MkDocs-Dokumentation

2026-03-04 14:18:33 +00:00
parent 6115090da1
commit 31d3e36597
97 changed files with 27518 additions and 1 deletions
--- a/docs/architecture/index.md
+++ b/docs/architecture/index.md
@@ -0,0 +1,112 @@
+# Architektur
+
+Ripster ist als klassische **Client-Server-Anwendung** mit Echtzeit-Kommunikation über WebSockets aufgebaut.
+
+---
+
+## Systemüberblick
+
+```mermaid
+graph TB
+    subgraph Browser["Browser (React)"]
+        Dashboard["Dashboard"]
+        Settings["Einstellungen"]
+        History["History"]
+    end
+
+    subgraph Backend["Node.js Backend"]
+        API["REST API\n(Express)"]
+        WS["WebSocket\nServer"]
+        Pipeline["Pipeline\nService"]
+        DB["SQLite\nDatenbank"]
+    end
+
+    subgraph ExternalTools["Externe Tools"]
+        MakeMKV["makemkvcon"]
+        HandBrake["HandBrakeCLI"]
+        MediaInfo["mediainfo"]
+    end
+
+    subgraph ExternalAPIs["Externe APIs"]
+        OMDb["OMDb API"]
+        PushOver["PushOver"]
+    end
+
+    Browser <-->|HTTP REST| API
+    Browser <-->|WebSocket| WS
+    Pipeline --> MakeMKV
+    Pipeline --> HandBrake
+    Pipeline --> MediaInfo
+    Pipeline <-->|Metadaten| OMDb
+    Pipeline -->|Benachrichtigungen| PushOver
+    API --> DB
+    Pipeline --> DB
+```
+
+---
+
+## Schichten-Architektur
+
+### Backend
+
+```
+index.js (Express Server)
+├── Routes (API-Endpunkte)
+│   ├── pipelineRoutes.js
+│   ├── settingsRoutes.js
+│   └── historyRoutes.js
+├── Services (Business Logic)
+│   ├── pipelineService.js    ← Kern-Orchestrierung
+│   ├── diskDetectionService.js
+│   ├── processRunner.js
+│   ├── websocketService.js
+│   ├── omdbService.js
+│   ├── settingsService.js
+│   ├── notificationService.js
+│   ├── historyService.js
+│   └── logger.js
+├── Database
+│   ├── database.js
+│   └── defaultSettings.js
+└── Utils
+    ├── encodePlan.js
+    ├── playlistAnalysis.js
+    ├── progressParsers.js
+    └── files.js
+```
+
+### Frontend
+
+```
+App.jsx (React Router)
+├── Pages
+│   ├── DashboardPage.jsx     ← Haupt-Interface
+│   ├── SettingsPage.jsx
+│   └── HistoryPage.jsx
+├── Components
+│   ├── PipelineStatusCard.jsx
+│   ├── MetadataSelectionDialog.jsx
+│   ├── MediaInfoReviewPanel.jsx
+│   ├── DynamicSettingsForm.jsx
+│   └── JobDetailDialog.jsx
+├── Hooks
+│   └── useWebSocket.js
+└── API
+    └── client.js
+```
+
+---
+
+## Weiterführende Dokumentation
+
+<div class="grid cards" markdown>
+
+-   [:octicons-arrow-right-24: Übersicht](overview.md)
+
+-   [:octicons-arrow-right-24: Backend-Services](backend.md)
+
+-   [:octicons-arrow-right-24: Frontend-Komponenten](frontend.md)
+
+-   [:octicons-arrow-right-24: Datenbank](database.md)
+
+</div>