From f0ec313d0ffb5abfd57da24afe0cf84752111ee9 Mon Sep 17 00:00:00 2001 From: Sascha Date: Mon, 14 Sep 2026 15:34:23 +0200 Subject: [PATCH] Dokumentation: docs/README.md --- docs/README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3f7f437 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,59 @@ +# Dokumentation ICON CRM + +Technische Dokumentation mit Funktionszeichnungen. Die Diagramme sind Mermaid und +werden von Gitea direkt gerendert. + +**Neu hier?** Wer die Anwendung *benutzen* will, fängt bei +[08 Anleitung für Benutzer](08-anleitung-benutzer.md) an. Wer daran *entwickeln* +will, bei [09 Anleitung für Entwickler](09-anleitung-entwickler.md). Beide setzen +keine Vorkenntnisse voraus. + +| Kapitel | Inhalt | +| --- | --- | +| [01 Architektur](01-architektur.md) | Topologie, Prozesse, Ports, Anfrageweg, Rollen | +| [02 Datenmodell](02-datenmodell.md) | Alle Tabellen als ER-Diagramm, Feld für Feld | +| [03 Frontend](03-frontend.md) | Ansichten, Menü, Komponentenkarte, Designs, Zustand | +| [04 Diktat](04-diktat.md) | Spracherkennung im Browser, Lebenszyklus des Modells | +| [05 KI](05-ki.md) | CV-Import, Schreibhilfe, erweiterte Suche | +| [06 Schnittstellen](06-schnittstellen.md) | ICON Website, perinco CRM in beide Richtungen | +| [07 Betrieb](07-betrieb.md) | Deployment, Umgebungsvariablen, Dienste, Störungssuche | +| [08 Anleitung für Benutzer](08-anleitung-benutzer.md) | Bedienung aller Bereiche, Schritt für Schritt | +| [09 Anleitung für Entwickler](09-anleitung-entwickler.md) | Einrichten, erweitern, bekannte Fallen | +| [10 API-Referenz](10-api.md) | Jeder Endpunkt, seine Rechte und seine Antwort | +| [11 Glossar](11-glossar.md) | Lead, Ausschreibung, Phase, Art, Status – was was bedeutet | + +Die Designentscheidungen stehen im [README des Projekts](../README.md). + +## Das Ganze in einem Bild + +```mermaid +flowchart TB + subgraph Browser + SPA["React-SPA
Vite-Build"] + WSP["Whisper im Web Worker
WebGPU / WASM"] + end + + subgraph Server["Server 31.70.144.60"] + AP["Apache :443"] + API["Express-Backend
127.0.0.1:5007"] + WEB["ICON Website
/var/www/icon_website/dist"] + DB[("MariaDB
icon_CRM")] + end + + OAI["OpenAI
gpt-5.6-luna"] + PCRM["perinco CRM
pcrm.perinco.de"] + HF["Hugging-Face-CDN"] + + SPA -->|"HTTPS /api"| AP + AP --> API + API --> DB + API -->|"CV-Auslesung, Schreibhilfe, erweiterte Suche"| OAI + API <-->|"Token, nur GET"| PCRM + WEB -->|"/api/public/tenders (gleiche Herkunft)"| AP + SPA -.->|"Audio bleibt im Browser"| WSP + HF -.->|"einmalig ~300 MB"| WSP +``` + +Das CRM ersetzt seit dem 14.09.2026 den Supabase-Aufbau des alten ICON CRM. Die +ICON Website liegt seither auf demselben Server und liest ihre Projektbörse aus +derselben MariaDB – über einen öffentlichen, ausschließlich lesenden Endpunkt.