API SOLID Node.js

API de uma aplicação no estilo GymPass desenvolvida em Node.js com TypeScript, Fastify e Prisma, seguindo os princípios SOLID para um código limpo, escalável e de fácil manutenção.

Principais Funcionalidades da Aplicação

• Usuários (Users): Podem se cadastrar, autenticar e visualizar seus perfis.
• Academias (Gyms): Podem ser cadastradas, buscadas por nome ou proximidade.
• Check-ins: Usuários podem realizar check-in em academias, com regras de negócio como validação de distância e limite de check-ins por dia.

Tecnologias Utilizadas

• Node.js: Ambiente de execução do JavaScript no servidor.
• TypeScript: Superset do JavaScript que adiciona tipagem estática.
• Fastify: Framework web focado em performance e baixo overhead.
• Prisma: ORM para Node.js e TypeScript, utilizado para a comunicação com o banco de dados (PostgreSQL).
• Zod: Biblioteca para validação de esquemas e tipos.
• Vitest: Framework de testes para projetos Vite (e Node.js).
• Docker: Utilizado para criar um ambiente de desenvolvimento com PostgreSQL.
• TSX: Executa arquivos TypeScript diretamente sem a necessidade de compilação prévia em desenvolvimento.
• TSUP: Bundler para bibliotecas TypeScript.

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