Configuración para colaboradores

Requisitos

• Git (Esencial)
• Node.js v24.16.0 (Esencial)
• npm v11.16.0 (Esencial)
• MongoDB (Esencial, para la base de datos)
• Git LFS (Útil para archivos más grandes)
• GitHub Desktop (Opcional)
• VSCode (Editor de código fuente recomendado)

Extensiones de VSCode recomendadas

Instala estas extensiones en VS Code:

• Prettier
• ESLint
• GitLens

Preparar el entorno

Node.js y npm

Si utilizas nvm, instala y selecciona la versión de Node.js recomendada antes de instalar LibreChat:

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

Verifica que tu shell esté utilizando las versiones esperadas:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Haz un fork del repositorio de LibreChat: https://github.com/danny-avila/LibreChat/fork

• Crea una rama en tu fork, asígnale un nombre adecuado y vincúlala al repositorio original.

• Descarga tu nueva rama a tu PC local

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

Reemplaza branch-name y username con tus detalles

Abrir en VS Code

• Después de clonar tu rama:

  cd LibreChat

  code .

Preparar LibreChat

• Abre la terminal en VS Code con ctrl+shift+`` ```

  Alternativamente, usa ctrl+j para abrir el panel inferior y selecciona la terminal.

• npm run smart-reinstall

  Si acabas de cambiar las versiones de Node.js o npm, usa npm run reinstall una vez para una instalación limpia.

• npm run build

• Configuración de .env

  • Cree el archivo .env. Si no tiene uno, duplique .env.example y configúrelo.

Flujo de trabajo de desarrollo

Para un trabajo eficiente en LibreChat, utilice estos comandos:

• Iniciando el backend:

  • Utilice npm run backend para el funcionamiento normal.
  • Para el desarrollo activo, utilice npm run backend:dev para monitorear los cambios.
  • Acceda en http://localhost:3080/.

• Ejecución del Frontend en modo de desarrollo:

  • Asegúrate de que el backend esté ejecutándose.
  • Usa npm run frontend:dev para monitorear los cambios en el frontend.
  • Ver en http://localhost:3090/.

Pruebas locales

Antes de enviar, prueba tus actualizaciones localmente, consulta: Perform Tests Locally

Al ejecutar pruebas, asegúrate de que tus contribuciones sean robustas y estén listas para su integración.

Commit, Push, Pull Request (PR)

Realizar un commit

Commits marcan puntos de control lógicos en el desarrollo. Incluya mensajes claros que expliquen los cambios.

Ejemplo:

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

Enviar cambios

Push los cambios al repositorio remoto después de completar una funcionalidad o corregir un problema.

Ejemplo:

git push origin feature-branch-name

Crear una Pull Request (PR)

Pull Request fusiona los cambios de una rama de características en la rama principal.

1. Extrae los últimos cambios de la rama main y resuelve los conflictos.
2. Envía la rama de características actualizada.
3. Asegúrese de que el código siga las directrices del proyecto.

Ejemplo:

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

Acceda a su repositorio en un navegador y haga clic en "Contribute".

Revertir Commits de forma segura

Para deshacer cambios en una rama de características (feature branch), siga estos pasos con precaución:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Reemplace pick con drop para los commits que desea eliminar. Guarde y salga del editor.

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