Skip to content

brunoh5/03-api-solid

Repository files navigation

App

GymPass style app.

RFs (Requisitos funcionais - Funcionalidades da aplicação)

  • 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 - Caminhos que cada requisito pode tomar)

  • 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 - Requisitos técnicos)

  • A senha do usuário precisa estar criptografada;
  • Os dados da aplicação precisam estar persistidos em um banco PostgreSQL;
  • 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);

Docker

docker start/stop api-solid-pg docker run --name api-solid-pg -e POSTGRESQL_USERNAME=docker -e POSTGRESQL_PASSWORD=docker -e POSTGRESQL_DATABASE=apisolid -p 5432:5432 bitnami/postgresql

docker compose down deleta tudo docker compose stop para o container

SOLID - Uncle Bob (Clean Code)

D - Dependency Inversion Principle

TDD - Test driven development

Red - Causar o erro (Ex.: Quando criar o teste sem a implementação) Green - Resolver o erro Refactor - Refatorar

Nomenclatura para buscas

fetch - mais de uma informação - Uma Lista

get - uma única informação

CI - Continuous Integration

CD - Continuous Deployment/Delivery