https://github.com/adairjuneo/gym-pass-api-solid
This repository is part of my practical studies about software engineering and development.
https://github.com/adairjuneo/gym-pass-api-solid
docker fastify nodejs prisma-orm solid solid-principles
Last synced: about 2 months ago
JSON representation
This repository is part of my practical studies about software engineering and development.
- Host: GitHub
- URL: https://github.com/adairjuneo/gym-pass-api-solid
- Owner: adairjuneo
- Created: 2025-01-01T19:41:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-15T01:40:16.000Z (over 1 year ago)
- Last Synced: 2025-07-01T03:02:32.932Z (12 months ago)
- Topics: docker, fastify, nodejs, prisma-orm, solid, solid-principles
- Language: TypeScript
- Homepage:
- Size: 502 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GymPass Api 🏋️💪 - Software Design
GymPass api with SOLID principles.
## RFs (Requisitos Funcionais)
Oque o usuário pode ou não fazer na aplicação ou funcionalidades da aplicação. Esses requisitos podem
ser facilmente definidos quando ocorre a conversa com o cliente ou equipe que idealiza o produto caso
software nasça dentro de uma empresa. **Deve ser possível...**
- [x] Deve ser possível se cadastrar;
- [x] Deve ser possível se autenticar;
- [x] Deve ser possível cadastrar uma academia;
- [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 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-ins em uma academia;
- [x] Deve ser possível validar o check-in de um usuário;
## RNs (Regras de Negócio)
Caminhos que cada requisito funcional pode seguir, determinando sobre quais condições aquele
requisito funcional pode ou não ser executado. **O usuário não pode/deve...** ou **A "entidade" não pode/deve...**
- [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-ins se não estiver perto(100m) da academia;
- [x] Academias só podem ser cadastradas por administradores;
- [x] O check-in só pode ser validado até 20 minutos após criado;
- [x] O check-in só pode ser validado por administradores;
## RNFs (Requisitos não-funcionais)
São "regras" mais técnicas do que a nível de funcionalidades, determinando mais patters e métodos
para serem aplicados no desenvolvimento.
- [x] A senha do usuário precisa estar criptografada;
- [x] Os dados da aplicação precisam estar persistidos em um banco de dados PostgreSQL;
- [x] Todas as 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);
- [x] 🆕 Implementado metodologia de refresh-token para auxiliar o front-end;
_This repository is part of my practical studies about software engineering and development._
[dev-juneo](https://github.com/adairjuneo)