Vue d'ensemble

Comment configurer un flux de travail de développement productif pour LibreChat.

Docker est la méthode d'installation privilégiée pour la plupart des utilisateurs, mais le développement local de LibreChat devrait utiliser npm. Exécuter l'application directement sur votre machine permet un retour plus rapide, un débogage plus clair et un accès direct aux espaces de travail du monorepo sans avoir à reconstruire les conteneurs après chaque modification.

Chaîne d'outils recommandée

Utilisez cette chaîne d'outils pour le développement basé sur npm :

Outil	Version
Node.js	`v24.16.0`
npm	`v11.16.0`
MongoDB	Atlas ou Community Server

Node 24 répond aux besoins d'exécution de LibreChat pour l'interopérabilité CommonJS avec les paquets ESM-only, WebCrypto et l'API Fetch. Si votre shell indique toujours une version plus ancienne de Node, exécutez nvm use 24.16.0 depuis le répertoire de LibreChat avant d'installer les dépendances.

Travaillez dans le bon espace de travail

LibreChat est un monorepo. Choisissez le plus petit espace de travail qui gère le comportement que vous modifiez :

Espace de travail	Utilisation
`/packages/api`	Nouveaux services backend TypeScript, contrôleurs et logique serveur partagée
`/api`	Intégration du serveur Express hérité ; gardez les modifications légères
`/packages/data-schemas`	Modèles de base de données, schémas et logique partagée spécifique à la base de données
`/packages/data-provider`	Types d'API partagés, endpoint, clés de requête et fonctions de service de données
`/client`	Code de l'application React
`/packages/client`	Utilitaires frontend partagés

Commandes quotidiennes

Commande	Objectif
`npm run smart-reinstall`	Installer les dépendances si nécessaire et compiler les espaces de travail
`npm run reinstall`	Installation propre après un changement de version Node/npm ou en cas de doute sur l'état des dépendances
`npm run backend:dev`	Démarrer le backend avec surveillance des fichiers
`npm run frontend:dev`	Démarrer le serveur de développement frontend sur le port `3090`
`npm run build:data-provider`	Recompiler le code partagé data-provider après des changements d'API/types
`npm run build`	Compiler tous les espaces de travail via Turborepo

Ressources de développement

Si vous débutez avec les dépôts, les forks, les branches et les pull requests, commencez par le guide de développement collaboratif de GitHub.
Lisez les Contributor Guidelines avant d'ouvrir une PR.
Utilisez Contributor Setup pour le flux complet de configuration locale.
Utilisez les Code Standards and Conventions pour les limites de l'espace de travail, l'ordre des imports, le typage, les tests et les règles de frontend.