Ir para o conteúdo

Documentação do Projeto Squad 07

Bem-vindo à documentação do projeto Squad 07. Este site contém documentação abrangente sobre a arquitetura do nosso projeto, detalhes de implementação e materiais de estudo.

Visão Geral do Projeto

Squad 07 é um projeto 2026 que combina: - Backend: FastAPI com PostgreSQL e Prisma ORM - Frontend: Next.js com TypeScript - Infraestrutura: Docker e pipelines CI/CD - Componentes de IA: Agentes de IA e processamento de linguagem natural

Começando

Pré-requisitos

  • Docker e Docker Compose
  • Python 3.x (para backend)
  • Node.js 18+ (para frontend)

Início Rápido

  1. Clone o repositório
  2. Execute docker-compose up para iniciar os serviços
  3. Backend: http://localhost:8000
  4. Frontend: http://localhost:3000
  5. Documentação: http://localhost:8001 (execute mkdocs serve)

Estrutura da Documentação

  • Arquitetura - Design do sistema, diagramas C4 e organização de pastas
  • Backend - Endpoints da API, esquema de banco de dados e documentação de serviços
  • Frontend - Biblioteca de componentes, estilos e arquitetura do frontend
  • Estudos - Materiais de aprendizado sobre tecnologias, metodologias e melhores práticas

Arquitetura de Software

A documentação técnica de arquitetura foi organizada para acelerar o onboarding e manter a evolução do repositório previsível.

  • Visão Geral - panorama das camadas, responsabilidades e fluxo principal entre frontend, backend e persistência
  • Estrutura de Pastas - folder tree recomendada e convenções para crescimento do projeto
  • Padrões de Projeto - separação por camadas, service layer, fronteira de repositório e contratos explícitos

Essa seção foi escrita para responder rapidamente a três dúvidas comuns no início da implementação:

  • como o sistema está dividido;
  • onde cada nova feature deve entrar;
  • quais convenções arquiteturais o time deve preservar.

Arquivos principais:

Contribuindo

Ao adicionar documentação: 1. Crie arquivos markdown no diretório apropriado 2. Atualize a navegação do mkdocs.yml 3. Siga as melhores práticas de markdown 4. Inclua exemplos de código quando relevante

Última Atualização: 2026-04-30