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

Overzicht

Hoe je een productieve LibreChat-ontwikkelworkflow opzet.

Docker is het geprefereerde installatiepad voor de meeste gebruikers, maar lokale LibreChat-ontwikkeling moet npm gebruiken. Het direct uitvoeren van de app op je machine zorgt voor snellere feedback, duidelijkere foutopsporing en directe toegang tot de monorepo-workspaces zonder dat containers na elke wijziging opnieuw hoeven te worden gebouwd.

Gebruik deze toolchain voor npm-gebaseerde ontwikkeling:

ToolVersie
Node.jsv24.16.0
npmv11.16.0
MongoDBAtlas of Community Server

Node 24 voldoet aan de runtime-behoeften van LibreChat voor CommonJS-interop met ESM-only pakketten, WebCrypto en de Fetch API. Als je shell nog steeds een oudere Node-versie rapporteert, voer dan nvm use 24.16.0 uit vanuit de LibreChat-repository voordat je de dependencies installeert.

Werk in de juiste werkruimte

LibreChat is een monorepo. Kies de kleinste workspace die verantwoordelijk is voor het gedrag dat je aanpast:

WorkspaceGebruik het voor
/packages/apiNieuwe backend TypeScript-services, controllers en gedeelde serverlogica
/apiLegacy Express-serverintegratie; houd wijzigingen beperkt
/packages/data-schemasDatabasemodellen, schema's en databasespecifieke gedeelde logica
/packages/data-providerGedeelde API-types, endpoints, query-keys en data-servicefuncties
/clientReact-applicatiecode
/packages/clientGedeelde frontend-hulpprogramma's

Dagelijkse commando's

CommandoDoel
npm run smart-reinstallInstalleer dependencies wanneer nodig en bouw gecompileerde workspaces
npm run reinstallSchone installatie na het wijzigen van Node/npm-versies of wanneer de status van dependencies onbetrouwbaar is
npm run backend:devStart de backend met file watching
npm run frontend:devStart de frontend dev-server op poort 3090
npm run build:data-providerHerbouw gedeelde data-provider code na API/type-wijzigingen
npm run buildBouw alle gecompileerde workspaces via Turborepo

Ontwikkelingsbronnen

Ontwikkelingsbronnen

Hoe is deze gids?