Skip to content

fabiobrasileiroo/api-gym-pass

Repository files navigation

App

GymPass style app.

RFs (Requisitos funcionais)

obs: é uma declaração de como um sistema deve se comportar

  • 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 o usuário 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 uma usuário;
  • Deve ser possível cadastrar uma academia;

RNs (Regras de negócio)

obs: descreve um aspecto do negócio, definindo ou restringindo tanto sua estrutura quanto seu comportamento

  • O usuário não deve poder se cadastrar com 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)

obs: são os requisitos relacionados ao uso da aplicação em termos de desempenho, usabilidade, confiabilidade, segurança, disponibilidade, manutenção e tecnologias envolvidas. Estes requisitos dizem respeito a como as funcionalidades serão entregues ao usuário do software

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