Konfiguracja dla współtwórców

Wymagania

• Git (Niezbędne)
• Node.js v24.16.0 (Niezbędne)
• npm v11.16.0 (Niezbędne)
• MongoDB (Niezbędne, dla bazy danych)
• Git LFS (Przydatne w przypadku większych plików)
• GitHub Desktop (Opcjonalnie)
• VSCode (Zalecany edytor kodu źródłowego)

Zalecane rozszerzenia VSCode

Zainstaluj te rozszerzenia w VS Code:

• Prettier
• ESLint
• GitLens

Przygotowanie środowiska

Node.js i npm

Jeśli używasz nvm, zainstaluj i wybierz zalecaną wersję Node.js przed instalacją LibreChat:

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

Zweryfikuj, czy twoja powłoka używa oczekiwanych wersji:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Sforkuj repozytorium LibreChat: https://github.com/danny-avila/LibreChat/fork

• Utwórz gałąź (branch) na swoim forku, nazwij ją odpowiednio i połącz z oryginalnym repozytorium.

• Pobierz nową gałąź na swój lokalny komputer

git clone -b branch-name https://github.com/username/LibreChat.git

Zastąp branch-name oraz username swoimi danymi

Otwórz w VS Code

• Po sklonowaniu swojej gałęzi:

  cd LibreChat

  code .

Przygotowanie LibreChat

• Otwórz terminal w VS Code za pomocą ctrl+shift+`

  Alternatywnie użyj ctrl+j, aby otworzyć dolny panel i wybrać terminal.

• npm run smart-reinstall

  Jeśli właśnie zmieniłeś wersje Node.js lub npm, użyj jednorazowo npm run reinstall w celu wykonania czystej instalacji.

• npm run build

• Konfiguracja .env

  • Utwórz plik .env. Jeśli go nie masz, skopiuj .env.example i skonfiguruj go.

Przepływ pracy programistycznej

Aby efektywnie pracować z LibreChat, użyj tych poleceń:

• Uruchamianie backendu:

  • Użyj npm run backend do normalnej pracy.
  • W przypadku aktywnego programowania użyj npm run backend:dev, aby monitorować zmiany.
  • Uzyskaj dostęp pod adresem http://localhost:3080/.

• Uruchamianie frontendu w trybie deweloperskim:

  • Upewnij się, że backend jest uruchomiony.
  • Użyj npm run frontend:dev, aby monitorować zmiany we frontendzie.
  • Zobacz pod adresem http://localhost:3090/.

Lokalne testowanie

Przed wysłaniem zmian przetestuj je lokalnie, zobacz: Perform Tests Locally

Uruchamiając testy, upewnij się, że Twoje zmiany są solidne i gotowe do integracji.

Commit, Push, Pull Request (PR)

Utwórz commit

Commity wyznaczają logiczne punkty kontrolne w procesie tworzenia. Dołączaj jasne komunikaty wyjaśniające wprowadzone zmiany.

Przykład:

git add .
git commit -m "Add login functionality"

Wypchnij zmiany

Wypchnij (push) zmiany do zdalnego repozytorium po ukończeniu funkcji lub naprawieniu błędu.

Przykład:

git push origin feature-branch-name

Utwórz Pull Request (PR)

Pull Request scala zmiany z gałęzi funkcji (feature branch) do głównej gałęzi (main branch).

1. Pobierz najnowsze zmiany z gałęzi main i rozwiąż konflikty.
2. Wypchnij zaktualizowaną gałąź funkcji.
3. Upewnij się, że kod jest zgodny z wytycznymi projektu.

Przykład:

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

Uzyskaj dostęp do swojego repozytorium w przeglądarce i kliknij „Contribute”.

Bezpieczne wycofywanie commitów

Aby cofnąć zmiany w gałęzi funkcji (feature branch), wykonaj ostrożnie poniższe kroki:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Zastąp pick przez drop dla commitów, które chcesz usunąć. Zapisz i zamknij edytor.

• git push --force-with-lease origin feature-branch-name