Gympass API - Node.js 🚀

Gympass API é uma API desenvolvida em Node.js para o usuário realizar check-in em academias.

---

💻 Sobre

A ideia deste projeto é criar uma API para registrar o check-in do usuário em academias próximas através da sua localização de GPS.

Essa API permite a criação de usuários, além da realização de Login, a criação de check-ins e a criação de academias(caso seja administrador da aplicação). Todo o controle de usuários é feito por meio de Tokens de Autenticação usando ainda Refresh Token.

---

🛠 Tecnologias

As seguintes tecnologias foram empregadas na criação deste projeto:

• Node.js
• TypeScript
• ESLint
• Fastify
• Fastify Cookie
• Zod
• Vitest
• Supertest
• Tsup
• Prisma

---

🚀 Regras da Aplicação

RFs (Requisitos funcionais)

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

RNs (Regras de negócio)

• 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 ser criado;
• O check-in só pode ser validado por administradores;
• A academia só pode ser cadastrada por administradores;

RNFs (Requisitos não-funcionais)

• 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);

---

🚀 Como utilizar

Clone o projeto para o local desejado em seu computador.

$ git clone git@github.com:andreviapiana/Projeto03-Gympass-API-Solid.git

---

🚧 Executando a Aplicação

# Navegue até o diretório
$ cd Projeto03-Gympass-API-Solid

# Instale as dependências necessárias
$ npm install

# Execute as Migrations para criar o Banco de Dados
$ npx prisma migrate dev

# Agora inicie a API
$ npm run dev

🚧 Instalando o Banco de Dados Local

# Instale o Docker Desktop em seu computador através deste link
$ https://docs.docker.com/desktop/install/windows-install/

# Abra um novo terminal(sem fechar o terminal do passo anterior) e navegue até o diretório
$ cd Projeto03-Gympass-API-Solid

# Abra um novo terminal e execute o seguinte código para instalar o Banco(o Docker deve estar instalado e em execução)
$ docker compose up -d

# No seu Docker será instalado o Banco de Dados desta aplicação.
# Com o Banco do Docker em execução e a API em execução, basta realizar as requisições pelo Insomnia.

---

📇 Insomnia da API

Instale o Insomnia, e então clique no botão a seguir para abrir as requisições já configuradas. Ao fazer a primeira requisição pode ser que o tempo limite seja atingido, pois o servidor gratuito pode demorar 1 minuto para startar.

---

🔀 Rotas da API

• Criar Novo Usuário

POST /users

• Autenticação/Login

POST /sessions

• Refresh Token

PATCH /token/refresh

• Exibir o perfil do Usuário

GET /me

• Criar uma Academia (somente Admin)

POST /gyms

---

📚 Testes automatizados

# A API possuí diversos testes. Após a instalação do projeto e suas depêndencias:
  npm run test

---

Made with ❤️ by André Viapiana 👋🏽 Get in Touch!

---