Este repositório contém a implementação da Gympass Style API Solid (similar ao Gympass), uma API RESTful em:
- Node.js 18
- NPM 9.5.1
- Docker 23.0.1
A API utiliza princípios SOLID com partes de Arquitetura Limpa para manter o código modular e escalável.
- Faça o clone deste repositório:
git clone
- Certifique-se de ter o Node.js 18 e NPM 9.5.1 instalados em sua máquina.
- Instale o Docker 23.0.1 em sua máquina.
- Copie o arquivo .env.example para .env na raiz do projeto e defina as variáveis de ambiente necessárias para o seu ambiente.
- Execute
docker-compose up
na pasta raiz do projeto para criar e executar os containers da API. - Após subir o banco de dados com sucesso, execute
npx prisma migrate dev
para preparar o banco de dados. - Por fim, execute
npm run start:dev
para subir a aplicação em modo de desenvolvimento.
A API oferece os seguintes endpoints:
GET /check-ins/history 📋 Retorna o histórico de check-ins do usuário autenticado.
GET /check-ins/metrics 📈 Retorna as métricas de check-ins do usuário autenticado.
POST /gyms/:gymId/check-ins ✔️ Registra um check-in do usuário autenticado na academia identificada por gymId.
PATCH /check-ins/:checkInId/validate ✅ Valida o check-in identificado por checkInId.
GET /gyms/search 🔍 Busca academias por nome ou endereço.
GET /gyms/nearby 📍 Retorna as academias próximas à localização do usuário autenticado.
POST /gyms 🏋️♂️ Registra uma nova academia na base de dados.
POST /users 👥 Registra um novo usuário na base de dados.
POST /sessions 🔑 Realiza a autenticação do usuário e retorna um token de acesso.
PATCH /token/refresh 🔄 Atualiza o token de acesso do usuário autenticado.
GET /me 👤 Retorna as informações do usuário autenticado.
A API utiliza autenticação por token. Para acessar os endpoints que requerem autenticação, é necessário enviar um token de acesso válido no header Authorization da requisição. O token pode ser obtido através do endpoint /sessions.
O usuário vai fazer X na 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 o seu histórico de check-ins;
- Deve ser possível o usuário buscar academias próximas;
- Deve ser possível o usuário buscar academias pelo nome;
- Deve ser possível um usuário realizar um check-in em uma academia;
- Deve ser possível validar o check-in de um usuário;
- Deve ser possível cadastrar uma academia;
O que o usuário vai poder fazer X na aplicação com condições (similar aos ifs).
- O usuário não deve 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;
Requisitos mais técnicos.
- A senha do usuário precisa estar criptografada;
- Os dados da aplicação precisam estar persistidos em um banco PostegreSQL;
- Todas as listas de dados precisam estar paginados com 20 itens por página;
- O usuário deve ser identificado por um JWT (Jason Web Token);
Este projeto é licenciado sob a licença MIT.