A GymPass API é uma aplicação que permite o gerenciamento de check-ins em academias. Com ela, é possível realizar o cadastro de usuários e academias, além de permitir a busca de academias por nome.
Inicie o banco de dados
docker-compose up -dInstale as dependências
npm installCrie e preencha as variáveis de ambiente no arquivo .env
cp .env.example .envPrepare o Husky
npm run prepareExecute as migrations
npm run db:migrate-devRode o projeto
npm run start:dev- 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 o 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 usuário;
- Deve ser possível cadastrar uma academia;
- O usuário não deve poder se cadastrar com um e-mail duplicado;
- O usuário não poder fazer 2 check-ins no mesmo dia;
- O usuário não pode fazer check-in se não tiver 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;
- A senha do usuário precisa estar criptografada;
- Os dados da aplicação precisam estar persistidos em um banco PostgreSQL;
- Todas listas de dados precisam estar paginadas com 20 itens por página;
- O usuário deve ser identificado por um JWT (JSON Web Token)
- Criar documentação API
- Botão Insomnia
Utilize o comando a seguir para executar os testes unitários
npm run test:unitUtilize o comando a seguir para executar os testes e2e
npm run test:e2e