Einrichtung für Mitwirkende

Anforderungen

• Git (Essentiell)
• Node.js v24.16.0 (Erforderlich)
• npm v11.16.0 (Erforderlich)
• MongoDB (Essenziell, für die Datenbank)
• Git LFS (Nützlich für größere Dateien)
• GitHub Desktop (Optional)
• VSCode (Empfohlener Quellcode-Editor)

Empfohlene VSCode-Erweiterungen

Installieren Sie diese Erweiterungen in VS Code:

• Prettier
• ESLint
• GitLens

Umgebung vorbereiten

Node.js und npm

Wenn Sie nvm verwenden, installieren und wählen Sie die empfohlene Node.js-Version aus, bevor Sie LibreChat installieren:

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

Überprüfen Sie, ob Ihre Shell die erwarteten Versionen verwendet:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Forken Sie das LibreChat-Repository: https://github.com/danny-avila/LibreChat/fork

• Erstellen Sie einen Branch auf Ihrem Fork, benennen Sie ihn angemessen und verknüpfen Sie ihn mit dem ursprünglichen Repository.

• Laden Sie Ihren neuen Branch auf Ihren lokalen PC herunter

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

Ersetzen Sie branch-name und username durch Ihre Details

In VS Code öffnen

• Nach dem Klonen deines Branch:

  cd LibreChat

  code .

LibreChat vorbereiten

• Öffnen Sie das Terminal in VS Code mit ctrl+shift+`` ```

  Alternativ können Sie ctrl+j verwenden, um den unteren Bereich zu öffnen und das Terminal auszuwählen.

• npm run smart-reinstall

  Falls Sie gerade die Node.js- oder npm-Versionen geändert haben, verwenden Sie einmal npm run reinstall für eine saubere Neuinstallation.

• npm run build

• .env Konfiguration

  • Erstellen Sie die .env Datei. Falls Sie noch keine haben, duplizieren Sie die .env.example und konfigurieren Sie diese.

Entwicklungs-Workflow

Für effizientes Arbeiten mit LibreChat verwenden Sie diese Befehle:

• Backend starten:

  • Verwenden Sie npm run backend für den normalen Betrieb.
  • Für die aktive Entwicklung verwenden Sie npm run backend:dev, um Änderungen zu überwachen.
  • Zugriff unter http://localhost:3080/.

• Frontend im Entwicklungsmodus ausführen:

  • Stellen Sie sicher, dass das Backend läuft.
  • Verwenden Sie npm run frontend:dev, um Änderungen am Frontend zu überwachen.
  • Aufrufen unter http://localhost:3090/.

Lokales Testen

Bevor Sie Ihre Änderungen einreichen, testen Sie diese lokal. Siehe: Perform Tests Locally

Stellen Sie durch das Ausführen von Tests sicher, dass Ihre Beiträge robust und bereit für die Integration sind.

Commit, Push, Pull Request (PR)

Einen Commit erstellen

Commits markieren logische Prüfpunkte in der Entwicklung. Fügen Sie klare Nachrichten hinzu, die die Änderungen erläutern.

Beispiel:

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

Änderungen übertragen

Push die Änderungen nach Abschluss eines Features oder der Behebung eines Fehlers in das Remote-Repository.

Beispiel:

git push origin feature-branch-name

Einen Pull Request (PR) erstellen

Pull Request führt Änderungen aus einem Feature-Branch in den Haupt-Branch zusammen.

1. Ziehe die neuesten Änderungen vom main-Branch und löse Konflikte.
2. Aktualisierten Feature-Branch pushen.
3. Stellen Sie sicher, dass der Code den Projektrichtlinien entspricht.

Beispiel:

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

Greifen Sie in einem Browser auf Ihr Repository zu und klicken Sie auf "Contribute".

Commits sicher rückgängig machen

Um Änderungen in einem Feature-Branch rückgängig zu machen, befolgen Sie diese Schritte vorsichtig:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Ersetzen Sie pick durch drop für Commits, die entfernt werden sollen. Speichern und schließen Sie den Editor.

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