Repositório de documentação da ferramenta de gestão de gincanas escolares desenvolvida pelo grupo de desenvolvedores G7 e gerenciada pelos gestores G3.
O código-fonte vive no repositório ScavengerProject-repo. Esta documentação foi
derivada diretamente do código (modelos, rotas, middlewares, suíte de testes e
configuração de CI/CD) e deve ser atualizada sempre que o software evoluir.
| # | Área | Documento | Conteúdo |
|---|---|---|---|
| 01 | Visão | Visão do Produto | Problema, objetivos, perfis, módulos |
| 02 | Requisitos | Requisitos Funcionais | RFs por módulo |
| 02 | Requisitos | Requisitos Não-Funcionais | Segurança, desempenho, disponibilidade |
| 03 | Arquitetura | Arquitetura | Stack, diagramas C4, componentes |
| 03 | Arquitetura | Modelo de Dados | MER + dicionário de dados |
| 03 | Arquitetura | Fluxos de Negócio | Diagramas de sequência |
| 03 | Arquitetura | Decisões (ADRs) | Registro de decisões arquiteturais |
| 04 | API | Referência da API REST | Todos os endpoints |
| 05 | Segurança | Matriz de Permissões | Perfis × operações |
| 06 | Testes | Plano de Testes | Estratégia e ambiente |
| 06 | Testes | Casos de Teste | Catálogo CT-* + relatório |
| 07 | Operação | Instalação e Deploy | Setup, variáveis, CI/CD |
| 08 | Manuais | Manual do Usuário | Guia por perfil |
| — | Referência | Glossário | Termos do domínio |
- Domínio: gestão de gincanas escolares — equipes, provas, ranking, penalidades, empréstimo/migração de participantes, feedbacks e notificações.
- Stack: React 19 + Vite + Tailwind (frontend) · Node.js + Express 5 + Mongoose (backend) · MongoDB Atlas · Redis + BullMQ (fila de e-mail) · Nodemailer.
- Perfis:
ADMIN,PROFESSOR,ALUNO,COORDENADOR,PAI/MÃE. - Autenticação: JWT (token com validade de 2 h) + senhas com hash bcrypt.
Nota de manutenção: os documentos das seções 03 (Modelo de Dados, API) e 05 (Permissões) refletem o estado do código na data de geração. Ao alterar modelos, rotas ou middlewares de autorização, atualize o documento correspondente.
Documentação gerada em 21/07/2026.