README.md

App

GymPass style app.

RFs (Requisitos funcionais)

• Deve ser possível se cadastrar;
• Deve ser possível se autenticar;
• Deve ser possível obter o perfil de um usuário logado;
• Deve ser possível obter o número de check-ins realizados pelo usuário logado;
• Deve ser possível o usuário obter seu histórico de check-ins;
• Deve ser possível o usuário buscar academias próximas (até 10km);
• Deve ser possível o usuário buscar academias pelo nome;
• Deve ser possível o usuário realizar check-in em uma academia;
• Deve ser possível validar o check-in de um usuário;
• Deve ser possível cadastrar uma academia;

RNs (Regras de negócio)

• O usuário não deve poder se cadastrar com um e-mail duplicado;
• O usuário não pode fazer 2 check-ins no mesmo dia;
• O usuário não pode fazer check-in se não estiver perto (100m) da academia;
• O check-in só pode ser validado até 20 minutos após criado;
• O check-in só pode ser validado por administradores;
• A academia só pode ser cadastrada por administradores;

RNFs (Requisitos não-funcionais)

• A senha do usuário precisa estar criptografada;
• Os dados da aplicação precisam estar persistidos em um banco PostreSQL;
• Todas as listas de dados precisam estar paginadas com 20 itens por página;
• O usuário deve ser identificado por um JWT (JSON Web Token);

Design Patterns & Testes

• Caso de uso de registro;

• Repository Pattern;

• Vitest;

• In-Memory Databases;

• Coverage de testes;

• UI do Vitest;

• Factory Pattern;

• TTD -> Test-driven development;

Autenticação

• JWT - JSON Web Token;
• Fastify/jwt;

Testes E2E

• Test Environment do Prisma;
• Teste E2E de rotas de usuário;
• Teste E2E de rotas de academia;
• Teste E2E de rotas de check-ins;

Refresh Token & RBAC

• Estratégia de refresh de token;
• Implementação do refresh token;
• Autorização por cargos (RBAC);
• Testes de RBAC;

CI/CD da aplicação

• Executando testes unitários no CI;
• Executando testes E2E no CI;
• GitHub Actions;