Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Ü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.

Verwenden Sie diese Toolchain für die npm-basierte Entwicklung:

ToolVersion
Node.jsv24.16.0
npmv11.16.0
MongoDBAtlas 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:

ArbeitsbereichVerwendung dafür
/packages/apiNeue Backend-TypeScript-Dienste, Controller und gemeinsam genutzte Serverlogik
/apiLegacy-Express-Server-Integration; Änderungen gering halten
/packages/data-schemasDatenbankmodelle, Schemas und datenbankspezifische gemeinsame Logik
/packages/data-providerGemeinsame API-Typen, endpoint, Abfrageschlüssel und Datendienst-Funktionen
/clientReact-Anwendungscode
/packages/clientGemeinsame Frontend-Dienstprogramme

Tägliche Befehle

BefehlZweck
npm run smart-reinstallInstalliert Abhängigkeiten bei Bedarf und erstellt kompilierte Workspaces
npm run reinstallSaubere Installation nach dem Ändern von Node/npm-Versionen oder bei fehlerhaftem Abhängigkeitsstatus
npm run backend:devStartet das Backend mit Dateiüberwachung
npm run frontend:devStartet den Frontend-Entwicklungsserver auf Port 3090
npm run build:data-providerErstellt den geteilten data-provider-Code nach API-/Typ-Änderungen neu
npm run buildErstellt alle kompilierten Workspaces über Turborepo

Entwicklungsressourcen

Entwicklungsressourcen

Wie finden Sie diese Anleitung?