Übersicht
So richten Sie einen produktiven LibreChat-Entwicklungs-Workflow ein.
Docker ist der bevorzugte Installationsweg für die meisten Benutzer, aber für die lokale LibreChat-Entwicklung sollte npm verwendet werden. Das direkte Ausführen der App auf Ihrem Rechner ermöglicht schnelleres Feedback, klareres Debugging und direkten Zugriff auf die Monorepo-Workspaces, ohne dass Container nach jeder Änderung neu erstellt werden müssen.
Empfohlene Toolchain
Verwenden Sie diese Toolchain für die npm-basierte Entwicklung:
| Tool | Version |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas oder Community Server |
Node 24 erfüllt die Laufzeitanforderungen von LibreChat für CommonJS-Interoperabilität mit reinen ESM-Paketen, WebCrypto und der Fetch API. Falls Ihre Shell immer noch eine ältere Node-Version meldet, führen Sie nvm use 24.16.0 im LibreChat-Repository aus, bevor Sie die Abhängigkeiten installieren.
Arbeiten im richtigen Arbeitsbereich
LibreChat ist ein Monorepo. Wählen Sie den kleinsten Workspace, der für das Verhalten zuständig ist, das Sie ändern möchten:
| Arbeitsbereich | Verwendung dafür |
|---|---|
/packages/api | Neue Backend-TypeScript-Dienste, Controller und gemeinsam genutzte Serverlogik |
/api | Legacy-Express-Server-Integration; Änderungen gering halten |
/packages/data-schemas | Datenbankmodelle, Schemas und datenbankspezifische gemeinsame Logik |
/packages/data-provider | Gemeinsame API-Typen, endpoint, Abfrageschlüssel und Datendienst-Funktionen |
/client | React-Anwendungscode |
/packages/client | Gemeinsame Frontend-Dienstprogramme |
Tägliche Befehle
| Befehl | Zweck |
|---|---|
npm run smart-reinstall | Installiert Abhängigkeiten bei Bedarf und erstellt kompilierte Workspaces |
npm run reinstall | Saubere Installation nach dem Ändern von Node/npm-Versionen oder bei fehlerhaftem Abhängigkeitsstatus |
npm run backend:dev | Startet das Backend mit Dateiüberwachung |
npm run frontend:dev | Startet den Frontend-Entwicklungsserver auf Port 3090 |
npm run build:data-provider | Erstellt den geteilten data-provider-Code nach API-/Typ-Änderungen neu |
npm run build | Erstellt alle kompilierten Workspaces über Turborepo |
Entwicklungsressourcen
Entwicklungsressourcen
- Wenn Sie neu im Umgang mit Repositories, Forks, Branches und Pull Requests sind, beginnen Sie mit dem Leitfaden für kollaborative Entwicklung von GitHub.
- Lies die Contributor Guidelines, bevor du einen PR öffnest.
- Nutzen Sie Contributor Setup für den vollständigen lokalen Einrichtungsablauf.
- Verwenden Sie Code Standards and Conventions für Arbeitsbereichsgrenzen, Import-Reihenfolge, Typisierung, Tests und Frontend-Regeln.
Wie finden Sie diese Anleitung?