Visão geral
Como configurar um fluxo de trabalho de desenvolvimento produtivo no LibreChat.
Docker é o caminho de instalação preferencial para a maioria dos usuários, mas o desenvolvimento local do LibreChat deve usar npm. Executar o aplicativo diretamente na sua máquina proporciona um feedback mais rápido, depuração mais clara e acesso direto aos workspaces do monorepo sem a necessidade de reconstruir containers após cada alteração.
Toolchain Recomendada
Use esta toolchain para desenvolvimento baseado em npm:
| Ferramenta | Versão |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas ou Community Server |
O Node 24 atende às necessidades de tempo de execução do LibreChat para interoperação CommonJS com pacotes apenas ESM, WebCrypto e a Fetch API. Se o seu terminal ainda indicar uma versão mais antiga do Node, execute nvm use 24.16.0 a partir do repositório do LibreChat antes de instalar as dependências.
Trabalhe no Espaço de Trabalho Correto
LibreChat é um monorepo. Escolha o menor workspace que detém o comportamento que você está alterando:
| Workspace | Use-o para |
|---|---|
/packages/api | Novos serviços backend em TypeScript, controllers e lógica de servidor compartilhada |
/api | Integração com servidor Express legado; mantenha as alterações enxutas |
/packages/data-schemas | Modelos de banco de dados, schemas e lógica compartilhada específica do banco |
/packages/data-provider | Tipos de API compartilhados, endpoints, chaves de query e funções de data-service |
/client | Código da aplicação React |
/packages/client | Utilitários de frontend compartilhados |
Comandos Diários
| Comando | Objetivo |
|---|---|
npm run smart-reinstall | Instalar dependências quando necessário e compilar workspaces |
npm run reinstall | Instalação limpa após alterar versões do Node/npm ou quando o estado das dependências estiver suspeito |
npm run backend:dev | Iniciar o backend com monitoramento de arquivos |
npm run frontend:dev | Iniciar o servidor de desenvolvimento do frontend na porta 3090 |
npm run build:data-provider | Recompilar o código compartilhado do data-provider após alterações de API/tipo |
npm run build | Compilar todos os workspaces através do Turborepo |
Recursos de Desenvolvimento
Recursos de Desenvolvimento
- Se você é novo em repositórios, forks, branches e pull requests, comece pelo guia de desenvolvimento colaborativo do GitHub.
- Leia as Diretrizes para Contribuidores antes de abrir um PR.
- Use Contributor Setup para o fluxo completo de configuração local.
- Use Code Standards and Conventions para limites de workspace, ordem de importação, tipagem, testes e regras de frontend.
Como está este guia?