Descripción general
Cómo configurar un flujo de trabajo de desarrollo productivo en LibreChat.
Docker es la ruta de instalación preferida para la mayoría de los usuarios, pero el desarrollo local de LibreChat debe utilizar npm. Ejecutar la aplicación directamente en su máquina proporciona una respuesta más rápida, una depuración más clara y acceso directo a los espacios de trabajo del monorepo sin necesidad de reconstruir los contenedores después de cada cambio.
Cadena de herramientas recomendada
Utilice esta cadena de herramientas para el desarrollo basado en npm:
| Herramienta | Versión |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas o Community Server |
Node 24 satisface las necesidades de tiempo de ejecución de LibreChat para la interoperabilidad de CommonJS con paquetes exclusivamente ESM, WebCrypto y la Fetch API. Si tu shell todavía reporta una versión de Node más antigua, ejecuta nvm use 24.16.0 desde el repositorio de LibreChat antes de instalar las dependencias.
Trabaje en el área de trabajo correcta
LibreChat es un monorepo. Elige el espacio de trabajo más pequeño que contenga el comportamiento que estás modificando:
| Workspace | Úselo para |
|---|---|
/packages/api | Nuevos servicios de backend en TypeScript, controladores y lógica de servidor compartida |
/api | Integración del servidor Express heredado; mantenga los cambios mínimos |
/packages/data-schemas | Modelos de base de datos, esquemas y lógica compartida específica de la base de datos |
/packages/data-provider | Tipos de API compartidos, endpoint, claves de consulta y funciones de servicio de datos |
/client | Código de la aplicación React |
/packages/client | Utilidades de frontend compartidas |
Comandos diarios
| Comando | Propósito |
|---|---|
npm run smart-reinstall | Instalar dependencias cuando sea necesario y compilar los espacios de trabajo |
npm run reinstall | Instalación limpia tras cambiar versiones de Node/npm o cuando el estado de las dependencias es sospechoso |
npm run backend:dev | Iniciar el backend con monitoreo de archivos |
npm run frontend:dev | Iniciar el servidor de desarrollo del frontend en el puerto 3090 |
npm run build:data-provider | Recompilar el código compartido de data-provider tras cambios en API/tipos |
npm run build | Compilar todos los espacios de trabajo a través de Turborepo |
Recursos de desarrollo
Recursos de desarrollo
- Si eres nuevo en repositorios, forks, branches y pull requests, comienza con la guía de desarrollo colaborativo de GitHub.
- Lee las Contributor Guidelines antes de abrir un PR.
- Utilice Contributor Setup para el flujo completo de configuración local.
- Utilice Code Standards and Conventions para los límites del espacio de trabajo, el orden de las importaciones, el tipado, las pruebas y las reglas del frontend.
¿Qué te parece esta guía?