https://github.com/gustavo-developer/gympass-api
API REST. O projeto utiliza conceitos de clean architecture, factory pattern, autenticação JWT e geolocalização.
https://github.com/gustavo-developer/gympass-api
Last synced: 8 months ago
JSON representation
API REST. O projeto utiliza conceitos de clean architecture, factory pattern, autenticação JWT e geolocalização.
- Host: GitHub
- URL: https://github.com/gustavo-developer/gympass-api
- Owner: Gustavo-Developer
- Created: 2024-02-13T15:54:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T15:55:13.000Z (over 2 years ago)
- Last Synced: 2025-03-24T08:18:04.273Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://sore-lime-whale-cap.cyclic.app
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
API Node.js com SOLID | GymPass API REST 💻🚀
API REST desenvolvida no módulo Ignite da Rocketseat. O projeto utiliza conceitos de clean architecture, factory pattern, autenticação JWT e geolocalização.
A aplicação GymPass tem como objetivo gerenciar o tráfego de clientes em academias. Os usuários podem realizar o check-in nas academias, porém o check-in só é permitido se o usuário estiver a uma distância de até 100 metros da academia.
🛠 Tecnologias utilizadas:
- `prisma`: ORM para banco de dados.
- `supertest`: Testes de API.
- `tsup`: Compilação TypeScript.
- `tsx`: Suporte para TSX.
- `typescript`: Linguagem de programação.
- `vitest`: Ferramenta de teste.
- `fastify`: Framework web (Fastify).
- `zod`: Validação de dados (Zod).
## RFs (Requisitos funcionais)
- [x] Deve ser possível se cadastrar;
- [x] Deve ser possível se autenticar;
- [x] Deve ser possível obter o perfil de um usuário logado;
- [x] Deve ser possível obter o número de check-ins realizados pelo usuário logado;
- [x] Deve ser possível o usuário obter o seu histórico de check-ins;
- [x] Deve ser possível o usuário buscar academias próximas (até 10km);
- [x] Deve ser possível o usuário buscar academias pelo nome;
- [x] Deve ser possível o usuário realizar check-in em uma academia;
- [x] Deve ser possível validar o check-in de um usuário;
- [x] Deve ser possível cadastrar uma academia;
## RNs (Regras de negócio)
- [x] O usuário não deve poder se cadastrar com um e-mail duplicado;
- [x] O usuário não pode fazer 2 check-ins no mesmo dia;
- [x] O usuário não pode fazer check-in se não estiver perto (100m) da academia;
- [x] O check-in só pode ser validado até 20 minutos após ser criado;
- [x] O check-in só pode ser validado por administradores;
- [x] A academia só pode ser cadastrada por administradores;
## RNFs (Requisitos não-funcionais)
- [x] A senha do usuário precisa estar criptografada;
- [x] Os dados da aplicação precisam estar persistidos em um banco PostgreSQL;
- [x] Todas listas de dados precisam estar paginadas com 20 itens por página;
- [x] O usuário deve ser identificado por um JWT (JSON Web Token);
👷 Requisitos
Install git, node and yarn (or npm).
```bash
# Clone Repository
$ git clone https://github.com/Gustavo-Developer/gympass-api.git
# Go to server folder
$ cd api-03-solid-rocketseat
# Install Dependencies
$ npm install
# rename file .env.example to .env
# run docker compose
$ docker compose up -d
# run prisma
$ npx prisma migrate dev
# Run Tests
$ npm run test
$ npm run test:e2e
```