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.
Aanbevolen toolchain
Gebruik deze toolchain voor npm-gebaseerde ontwikkeling:
| Tool | Versie |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas 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:
| Workspace | Gebruik het voor |
|---|---|
/packages/api | Nieuwe backend TypeScript-services, controllers en gedeelde serverlogica |
/api | Legacy Express-serverintegratie; houd wijzigingen beperkt |
/packages/data-schemas | Databasemodellen, schema's en databasespecifieke gedeelde logica |
/packages/data-provider | Gedeelde API-types, endpoints, query-keys en data-servicefuncties |
/client | React-applicatiecode |
/packages/client | Gedeelde frontend-hulpprogramma's |
Dagelijkse commando's
| Commando | Doel |
|---|---|
npm run smart-reinstall | Installeer dependencies wanneer nodig en bouw gecompileerde workspaces |
npm run reinstall | Schone installatie na het wijzigen van Node/npm-versies of wanneer de status van dependencies onbetrouwbaar is |
npm run backend:dev | Start de backend met file watching |
npm run frontend:dev | Start de frontend dev-server op poort 3090 |
npm run build:data-provider | Herbouw gedeelde data-provider code na API/type-wijzigingen |
npm run build | Bouw alle gecompileerde workspaces via Turborepo |
Ontwikkelingsbronnen
Ontwikkelingsbronnen
- Als je nieuw bent met repositories, forks, branches en pull requests, begin dan met GitHub's gids voor collaboratieve ontwikkeling.
- Lees de Contributor Guidelines voordat je een PR opent.
- Gebruik Contributor Setup voor de volledige lokale setup-procedure.
- Gebruik Code Standards and Conventions voor werkruimtegrenzen, importvolgorde, typering, testen en frontend-regels.
Hoe is deze gids?