🚀 Onboarding — iFriend Agents¶
Bem-vindo ao time! Esta documentação foi criada para que você entenda rapidamente o projeto iFriend Agents e comece a contribuir com confiança.
Leitura recomendada (em ordem)¶
| # | Documento | O que você vai aprender |
|---|---|---|
| 1 | Visão Geral do Projeto | O que é o iFriend Agents, stack tecnológica, estrutura de pastas |
| 2 | Arquitetura e Fluxo de Dados | Como uma mensagem do usuário percorre o sistema do início ao fim (com diagramas) |
| 3 | O Agente iFriend (ADK) | Como funciona o agente de IA: tools, prompts, callbacks, sub-agentes |
| 4 | Adaptadores de Mensageria | Como o bot conecta com Slack, WhatsApp, Telegram, WebChat e SSE |
| 5 | Sessão, Memória e Autenticação | Session services, memory services, JWT (sistêmico e de usuário) |
| 6 | Setup Local e Desenvolvimento | Como rodar o projeto na sua máquina, rodar testes e fazer deploy |
Tempo estimado de leitura¶
~45 minutos para leitura completa. Se estiver com pressa, comece pelos docs 1 e 2 (~15 min) para ter a visão macro, depois avance conforme a área em que vai atuar.
Convenções usadas nos diagramas¶
Os diagramas usam Mermaid e podem ser visualizados diretamente no GitHub, VS Code (com extensão Markdown Preview Mermaid) ou qualquer viewer Mermaid.
Dúvidas? Abra uma issue ou pergunte no canal do time. Nenhuma pergunta é boba — o projeto tem bastante superfície e é normal levar uns dias para ficar confortável.