Configuration pour les contributeurs

Prérequis

• Git (Essentiel)
• Node.js v24.16.0 (Essentiel)
• npm v11.16.0 (Essentiel)
• MongoDB (Essentiel, pour la base de données)
• Git LFS (Utile pour les fichiers plus volumineux)
• GitHub Desktop (Optionnel)
• VSCode (Éditeur de code source recommandé)

Extensions VSCode recommandées

Installez ces extensions dans VS Code :

• Prettier
• ESLint
• GitLens

Préparer l'environnement

Node.js et npm

Si vous utilisez nvm, installez et sélectionnez la version de Node.js recommandée avant d'installer LibreChat :

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

Vérifiez que votre shell utilise les versions attendues :

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Forkez le dépôt LibreChat : https://github.com/danny-avila/LibreChat/fork

• Créez une branche sur votre fork, nommez-la correctement et liez-la au dépôt original.

• Téléchargez votre nouvelle branche sur votre PC local

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

Remplacez branch-name et username par vos informations

Ouvrir dans VS Code

• Après avoir cloné votre branche :

  cd LibreChat

  code .

Préparer LibreChat

• Open the terminal in VS Code with ctrl+shift+`` ```

  Alternativement, utilisez ctrl+j pour ouvrir le volet inférieur et sélectionnez le terminal.

• npm run smart-reinstall

  Si vous venez de changer de version de Node.js ou de npm, utilisez npm run reinstall une fois pour une installation propre.

• npm run build

• Configuration de .env

  • Créez le fichier .env. Si vous n'en avez pas, dupliquez .env.example et configurez-le.

Flux de travail de développement

Pour un travail efficace sur LibreChat, utilisez ces commandes :

• Démarrage du backend :

  • Utilisez npm run backend pour un fonctionnement normal.
  • Pour le développement actif, utilisez npm run backend:dev pour surveiller les changements.
  • Accédez à http://localhost:3080/.

• Exécution du frontend en mode développement :

  • Assurez-vous que le backend est en cours d'exécution.
  • Utilisez npm run frontend:dev pour surveiller les changements du frontend.
  • Consultez à l'adresse http://localhost:3090/.

Test local

Avant la soumission, testez vos mises à jour localement, voir : Perform Tests Locally

En exécutant des tests, assurez-vous que vos contributions sont robustes et prêtes pour l'intégration.

Commit, Push, Pull Request (PR)

Effectuer un commit

Commits marquent des points de contrôle logiques dans le développement. Incluez des messages clairs expliquant les changements.

Exemple :

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

Pousser les modifications

Poussez les modifications vers le dépôt distant après avoir terminé une fonctionnalité ou corrigé un problème.

Exemple :

git push origin feature-branch-name

Créer une Pull Request (PR)

Pull Request fusionne les modifications d'une branche de fonctionnalité vers la branche principale.

1. Récupérez les dernières modifications de la branche main et résolvez les conflits.
2. Poussez la branche de fonctionnalité mise à jour.
3. Assurez-vous que le code respecte les directives du projet.

Exemple :

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

Accédez à votre dépôt dans un navigateur et cliquez sur "Contribute".

Annuler des commits en toute sécurité

Pour annuler des modifications dans une branche de fonctionnalité, suivez ces étapes avec prudence :

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Remplacez pick par drop pour les commits à supprimer. Enregistrez et quittez l'éditeur.

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