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

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.

Utilizza questa toolchain per lo sviluppo basato su npm:

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

WorkspaceUsalo per
/packages/apiNuovi servizi backend in TypeScript, controller e logica server condivisa
/apiIntegrazione del server Express legacy; mantieni le modifiche contenute
/packages/data-schemasModelli di database, schemi e logica condivisa specifica per il database
/packages/data-providerTipi API condivisi, endpoint, chiavi di query e funzioni del data-service
/clientCodice dell'applicazione React
/packages/clientUtility frontend condivise

Comandi giornalieri

ComandoScopo
npm run smart-reinstallInstalla le dipendenze quando necessario e compila i workspace
npm run reinstallInstallazione pulita dopo aver cambiato le versioni di Node/npm o quando lo stato delle dipendenze è sospetto
npm run backend:devAvvia il backend con il monitoraggio dei file
npm run frontend:devAvvia il server di sviluppo del frontend sulla porta 3090
npm run build:data-providerRicompila il codice condiviso del data-provider dopo modifiche a API/tipi
npm run buildCompila tutti i workspace tramite Turborepo

Risorse per lo sviluppo

Risorse per lo sviluppo

Com’è questa guida?