Przegląd
Jak skonfigurować produktywny przepływ pracy programistycznej w LibreChat.
Docker jest preferowaną ścieżką instalacji dla większości użytkowników, jednak lokalny rozwój LibreChat powinien odbywać się przy użyciu npm. Uruchomienie aplikacji bezpośrednio na własnym komputerze zapewnia szybszą informację zwrotną, wyraźniejsze debugowanie oraz bezpośredni dostęp do obszarów roboczych monorepo bez konieczności przebudowywania kontenerów po każdej zmianie.
Zalecany łańcuch narzędzi
Użyj tego łańcucha narzędzi do programowania opartego na npm:
| Narzędzie | Wersja |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas lub Community Server |
Node 24 spełnia wymagania środowiska uruchomieniowego LibreChat w zakresie współdziałania CommonJS z pakietami typu ESM-only, WebCrypto oraz Fetch API. Jeśli Twoja powłoka nadal zgłasza starszą wersję Node, uruchom nvm use 24.16.0 z poziomu repozytorium LibreChat przed zainstalowaniem zależności.
Pracuj w odpowiednim obszarze roboczym
LibreChat to monorepo. Wybierz najmniejszy obszar roboczy (workspace), który odpowiada za zachowanie, które zmieniasz:
| Obszar roboczy (Workspace) | Użyj go do |
|---|---|
/packages/api | Nowych usług backendowych w TypeScript, kontrolerów i współdzielonej logiki serwera |
/api | Integracji ze starszą wersją serwera Express; ogranicz zmiany do minimum |
/packages/data-schemas | Modeli baz danych, schematów i współdzielonej logiki specyficznej dla bazy danych |
/packages/data-provider | Współdzielonych typów API, endpointów, kluczy zapytań i funkcji usług danych |
/client | Kodu aplikacji React |
/packages/client | Współdzielonych narzędzi frontendowych |
Codzienne polecenia
| Polecenie | Cel |
|---|---|
npm run smart-reinstall | Instaluje zależności w razie potrzeby i buduje skompilowane obszary robocze |
npm run reinstall | Czysta instalacja po zmianie wersji Node/npm lub gdy stan zależności jest niepewny |
npm run backend:dev | Uruchamia backend z monitorowaniem plików |
npm run frontend:dev | Uruchamia serwer deweloperski frontendu na porcie 3090 |
npm run build:data-provider | Przebudowuje współdzielony kod data-provider po zmianach API/typów |
npm run build | Buduje wszystkie skompilowane obszary robocze za pomocą Turborepo |
Zasoby programistyczne
Zasoby programistyczne
- Jeśli dopiero zaczynasz przygodę z repozytoriami, forkami, branchami i pull requestami, zacznij od przewodnika GitHub dotyczącego wspólnego programowania.
- Przeczytaj Wytyczne dla współtwórców przed otwarciem PR.
- Skorzystaj z Contributor Setup, aby przejść przez pełny proces konfiguracji lokalnej.
- Użyj Code Standards and Conventions dla granic obszaru roboczego, kolejności importów, typowania, testowania oraz reguł frontendowych.
Jaka jest ta instrukcja?