Skip to content

pedrohpsantos/EdTech

Repository files navigation

EdTech Banner

Um repositório para transformar rigor acadêmico em software verificável — com decisões, evidências e responsabilidade.

EdTech — Governança Acadêmica e Repositório Científico

Documentação CI/CD React TypeScript Java Spring Boot Google Cloud Firebase

Visão geral

O EdTech centraliza a submissão, revisão, armazenamento e auditoria de documentos e datasets acadêmicos. A plataforma atende Pesquisadores, Orientadores e Auditores com rastreabilidade, autorização por perfil e trilha de auditoria.

Documentação oficial: pedrohpsantos.github.io/EdTech

Capacidades

  • Cadastro com verificação por e-mail, recuperação de senha e autenticação em dois fatores opcional.
  • Sessão JWT em cookie HttpOnly, Secure e SameSite=None; a SPA usa withCredentials e a API restringe CORS à origem autorizada.
  • Projetos, membros de laboratório e permissões por perfil.
  • Upload de PDF, CSV e JSON para o Google Cloud Storage, revisão, comentários, favoritos e links de download autorizados.
  • Auditoria filtrável e exportável, painel de métricas e indicadores de conformidade.
  • Migrações Flyway em Cloud Run Job e deploy automatizado para Cloud Run e Firebase Hosting.

Módulos

Módulo Responsabilidade Guia
Frontend SPA React/Vite, acessibilidade e jornadas dos perfis. frontend/README.md
Backend API Java/Spring Boot, regras de negócio, segurança e persistência. backend/README.md
Infraestrutura Ambiente local Docker, Terraform e recursos GCP. infra/README.md
Testes E2E, carga, contrato de segurança e Lighthouse. tests/README.md
Documentação Portal MkDocs Material e ADRs. docs/README.md
Scripts Verificação de backup e carga de contas demo locais. scripts/README.md
Postman Coleção manual da API. .postman/README.md

Comece aqui

Pré-requisitos: Docker Desktop com Docker Compose.

git clone https://github.com/pedrohpsantos/EdTech.git
cd EdTech

Copy-Item infra/dev/.env.example infra/dev/.env
# Edite infra/dev/.env e defina POSTGRES_PASSWORD e JWT_SECRET.

docker compose --env-file infra/dev/.env -f infra/dev/docker-compose.yml up --build -d
  • Frontend: http://localhost:5173
  • Backend: http://localhost:8080/actuator/health
  • Adminer: http://localhost:8081

Para encerrar: docker compose --env-file infra/dev/.env -f infra/dev/docker-compose.yml down.

Validação e entrega

main publica produção e develop publica staging. A CI valida backend, frontend e infraestrutura em paralelo; após o deploy, executa testes de produção conforme suas dependências:

  • k6 e contrato de segurança da API dependem do backend;
  • E2E Playwright e Lighthouse dependem do backend e do frontend.

Os relatórios são disponibilizados como artefatos da execução. Veja o fluxo completo em .github/PIPELINES.md.

Evidência que orienta decisões

O projeto não usa uma única métrica como selo de qualidade. JaCoCo mostra alcance do backend; PIT e Stryker testam a força das asserções; Playwright/Allure percorrem jornadas essenciais; k6 observa a API sob carga; Lighthouse acompanha a experiência da primeira visita. Os relatórios publicados transformam cada entrega em uma conversa objetiva sobre comportamento, segurança e desempenho.

Referências e contribuição

  1. Crie uma branch a partir de develop.
  2. Execute as validações do módulo alterado.
  3. Abra um PR para develop usando Conventional Commits.
  4. Promova para main somente após a CI de develop passar.

Consulte as pipelines, o guia de contribuição, o código de conduta, a política de segurança, o changelog e a licença MIT.

About

Plataforma web de gestão acadêmica e armazenamento em nuvem para laboratórios universitários e projetos de iniciação científica.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

0 watching

Forks

Contributors