💪 GymPass API

1. Clone este repositório em sua máquina local:

git clone https://github.com/pedrodecf/gympass-api

2. Instale as dependências necessárias:

npm install

3. Crie um arquivo .env no diretório do projeto para definir as variáveis de ambiente necessárias, consulte o arquivo .env.example fornecido para obter as variáveis necessárias e seus valores.

4. Configure o contêiner do banco de dados usando o Docker Compose:

docker compose up -d

5. Execute as migrations do Prisma para criar as tabelas do banco de dados:

npx prisma migrate dev

6. Inicie a API:

npm run start:dev

---

Como fazer testes na API

1. Execute os testes unitários:

npm run test

ou

npm run test:watch

2. Execute os testes E2E:

npm run test:e2e

ou

npm run test:e2e:watch

Este script acionará toda a configuração em um novo banco de dados que será gerado para executar os testes, sendo excluído após a conclusão dos testes e2e.

---

RFs (Requisitos funcionais)

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

RNs (Regras de negócios)

• O usuário não deve poder se cadastrar com um e-mail duplicado;
• O usário não pode fazer 2 check-ins no mesmo dia;
• O usuáriio 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 valido por administradores;
• A academia só pode ser cadastrado por administradores;

RNFs (Requisitos não funcionais)

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