Panoramica
Come configurare un flusso di lavoro di sviluppo produttivo per LibreChat.
Docker è il metodo di installazione preferito per la maggior parte degli utenti, ma lo sviluppo locale di LibreChat dovrebbe utilizzare npm. Eseguire l'app direttamente sulla propria macchina offre un feedback più rapido, un debug più chiaro e l'accesso diretto ai workspace del monorepo senza dover ricostruire i container dopo ogni modifica.
Toolchain consigliata
Utilizza questa toolchain per lo sviluppo basato su npm:
| Strumento | Versione |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas o Community Server |
Node 24 soddisfa i requisiti di runtime di LibreChat per l'interoperabilità CommonJS con pacchetti esclusivamente ESM, WebCrypto e la Fetch API. Se la tua shell segnala ancora una versione di Node precedente, esegui nvm use 24.16.0 dalla repository di LibreChat prima di installare le dipendenze.
Lavora nello spazio di lavoro giusto
LibreChat è un monorepo. Scegli il workspace più piccolo che gestisce il comportamento che stai modificando:
| Workspace | Usalo per |
|---|---|
/packages/api | Nuovi servizi backend in TypeScript, controller e logica server condivisa |
/api | Integrazione del server Express legacy; mantieni le modifiche contenute |
/packages/data-schemas | Modelli di database, schemi e logica condivisa specifica per il database |
/packages/data-provider | Tipi API condivisi, endpoint, chiavi di query e funzioni del data-service |
/client | Codice dell'applicazione React |
/packages/client | Utility frontend condivise |
Comandi giornalieri
| Comando | Scopo |
|---|---|
npm run smart-reinstall | Installa le dipendenze quando necessario e compila i workspace |
npm run reinstall | Installazione pulita dopo aver cambiato le versioni di Node/npm o quando lo stato delle dipendenze è sospetto |
npm run backend:dev | Avvia il backend con il monitoraggio dei file |
npm run frontend:dev | Avvia il server di sviluppo del frontend sulla porta 3090 |
npm run build:data-provider | Ricompila il codice condiviso del data-provider dopo modifiche a API/tipi |
npm run build | Compila tutti i workspace tramite Turborepo |
Risorse per lo sviluppo
Risorse per lo sviluppo
- Se non hai familiarità con repository, fork, branch e pull request, inizia con la guida allo sviluppo collaborativo di GitHub.
- Leggi le Linee guida per i contributori prima di aprire una PR.
- Utilizza Contributor Setup per il flusso completo di configurazione locale.
- Utilizza Code Standards and Conventions per i limiti dell'area di lavoro, l'ordine delle importazioni, la tipizzazione, i test e le regole del frontend.
Com’è questa guida?