GuiaDev

Entenda a solução, quem atendemos e como o sistema foi estruturado tecnicamente.

A Solução GuiaDev

O Guia Dev é uma aplicação web desenvolvida para apoiar desenvolvedores na criação e gestão de projetos sustentáveis. O sistema combate a falta de documentação e o retrabalho através de análises automatizadas e feedbacks inteligentes, promovendo a manutenibilidade e a padronização arquitetural.

Público-Alvo

Focado em Desenvolvedores de Software (Júnior a Sênior) e estudantes que necessitam organizar seus repositórios e validar se estão seguindo os padrões da indústria.

Necessidades Atendidas

  • Automação na verificação de documentação (README, CONTRIBUTING).
  • Redução de retrabalho em Code Reviews.
  • Feedback rápido sobre arquitetura de pastas.
  • Aprendizado contínuo via IA.

Arquitetura Geral

O sistema opera como uma Aplicação Web modular. O Front-end consome exclusivamente a API do Back-end, garantindo integrabilidade. O núcleo da inteligência reside na integração com o Agente Gemini para processamento assíncrono das análises.

Tecnologias (Stack):

Frontend Web API Backend Gemini GitHub API (OAuth) Google Auth Docker
// dev & ops

Desenvolvimento e Implementação

Detalhes da arquitetura técnica, stack de desenvolvimento e pipeline de entrega.

Arquitetura Modular

Estrutura baseada no Modelo C4, utilizando tecnologias modernas para garantir performance e manutenibilidade:

  • Frontend: React 18 + Vite (SPA) com TypeScript.
  • Backend: NestJS 9.x escalável com Prisma ORM.
  • Banco de Dados: PostgreSQL gerenciado (Supabase).

Decisões Arquiteturais

  • Autenticação Stateless: Uso de JWT para eliminar estado no servidor e facilitar a escala horizontal.
  • Processamento Assíncrono: Análises de IA executadas em background para evitar bloqueio da interface (Non-blocking I/O).
  • Type-Safety End-to-End: Uso rigoroso de TypeScript do Front ao Banco (via Prisma) para prevenir erros em tempo de execução.

Funcionalidades Entregues

Recursos principais implementados e validados no MVP.

1

Autenticação & Perfil

Login robusto via OAuth (GitHub/Google) ou credenciais locais. Gestão de sessão segura com JWT e recuperação de senha.

2

Dashboard de Repositórios

Sincronização automática com a API do GitHub. Listagem, busca e filtragem de projetos para análise de documentação.

3

Análise com IA (Gemini)

Feedback inteligente sobre a estrutura do projeto, gerando checklist de arquivos (README, CONTRIBUTING) e sugestões de melhoria.

Fluxos Demonstrativos

Fluxo de Login
Login Social

Fluxo de autenticação OAuth com GitHub.

Dashboard de Projetos
Seleção de Projetos

Importação e listagem de repositórios.

Resultado da Análise
Feedback da IA

Checklist gerado pelo Gemini.

4.3 Automação & DevOps

A infraestrutura utiliza pipelines automatizados para garantir que cada commit respeite os padrões de qualidade antes de chegar em produção.

Pipeline de Integração Contínua (CI)
  • Qualidade de Código (Static Analysis): Execução obrigatória de ESLint e Prettier para garantir padronização e evitar "code smells".
  • Testes Automatizados: Rodagem de testes unitários com Jest no Backend a cada Pull Request.
  • Build Verification: Compilação de teste do React (Vite) e NestJS para garantir integridade da build.
Deploy & Infraestrutura (CD)
  • Containerização (Docker): O Backend é empacotado em containers Docker para garantir paridade entre ambientes (Dev/Prod).
  • Cloud Provider (Render): Deploy automático da branch main no Render.com.
  • Database Migrations: Aplicação automática de migrações do Prisma no PostgreSQL (Supabase) durante o processo de build.

DevOps & Infraestrutura

Pipeline de CI/CD configurado para garantir entregas contínuas e qualidade de código.

CI/CD (GitHub Actions) Testes automatizados (Jest) e verificação de build a cada commit.
Infraestrutura (Cloud) Deploy no Render com Docker Containers e Banco no Supabase.