Setup voor bijdragers

Vereisten

• Git (Essentieel)
• Node.js v24.16.0 (Essentieel)
• npm v11.16.0 (Essentieel)
• MongoDB (Essentieel, voor de database)
• Git LFS (Handig voor grotere bestanden)
• GitHub Desktop (Optioneel)
• VSCode (Aanbevolen broncode-editor)

Aanbevolen VSCode-extensies

Installeer deze extensies in VS Code:

• Prettier
• ESLint
• GitLens

De omgeving voorbereiden

Node.js en npm

Als je nvm gebruikt, installeer en selecteer dan de aanbevolen Node.js-versie voordat je LibreChat installeert:

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

Controleer of je shell de verwachte versies gebruikt:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Fork de LibreChat repository: https://github.com/danny-avila/LibreChat/fork

• Maak een branch aan op je fork, geef deze een passende naam en koppel deze aan de originele repository.

• Download je nieuwe branch naar je lokale pc

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

Vervang branch-name en username door jouw gegevens

Openen in VS Code

• Na het klonen van je branch:

  cd LibreChat

  code .

LibreChat voorbereiden

• Open de terminal in VS Code met ctrl+shift+`` ```

  Gebruik anders ctrl+j om het onderste paneel te openen en de terminal te selecteren.

• npm run smart-reinstall

  Als je zojuist de Node.js- of npm-versies hebt gewijzigd, gebruik dan eenmaal npm run reinstall voor een schone installatie.

• npm run build

• .env Configuratie

  • Maak het .env bestand aan. Als je er nog geen hebt, dupliceer dan .env.example en configureer het.

Ontwikkelingsworkflow

Gebruik deze commando's voor efficiënt werken met LibreChat:

• Backend starten:

  • Gebruik npm run backend voor normaal gebruik.
  • Voor actieve ontwikkeling, gebruik npm run backend:dev om wijzigingen te monitoren.
  • Toegang via http://localhost:3080/.

• Frontend uitvoeren in ontwikkelmodus:

  • Zorg ervoor dat de backend draait.
  • Gebruik npm run frontend:dev om wijzigingen in de frontend te monitoren.
  • Bekijk op http://localhost:3090/.

Lokaal testen

Test je updates lokaal voordat je ze indient, zie: Perform Tests Locally

Door tests uit te voeren, zorg je ervoor dat je bijdragen robuust en klaar voor integratie zijn.

Commit, Push, Pull Request (PR)

Een commit maken

Commits markeren logische controlepunten in de ontwikkeling. Voeg duidelijke berichten toe die de wijzigingen uitleggen.

Voorbeeld:

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

Wijzigingen pushen

Push wijzigingen naar de remote repository nadat je een feature hebt voltooid of een probleem hebt opgelost.

Voorbeeld:

git push origin feature-branch-name

Een Pull Request (PR) aanmaken

Pull Request voegt wijzigingen van een feature branch samen in de main branch.

1. Haal de laatste wijzigingen op uit de main branch en los conflicten op.
2. Push de bijgewerkte feature branch.
3. Zorg ervoor dat de code de projectrichtlijnen volgt.

Voorbeeld:

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

Ga naar je repository in een browser en klik op "Contribute".

Commits veilig terugdraaien

Om wijzigingen in een feature branch ongedaan te maken, volg je deze stappen voorzichtig:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Vervang pick door drop voor commits die verwijderd moeten worden. Sla op en sluit de editor.

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