https://github.com/alexandrecpedro/gympass-api

Gympass API is a gym app API developed on Rocketseat Ignite course
https://github.com/alexandrecpedro/gympass-api

bcryptjs dayjs docker e2e-tests eslint fastify jwt nodejs postgresql prisma supertest typescript unit-testing vitest zod

Last synced: 9 days ago
JSON representation

Gympass API is a gym app API developed on Rocketseat Ignite course

• Host: GitHub
• URL: https://github.com/alexandrecpedro/gympass-api
• Owner: alexandrecpedro
• Created: 2023-08-18T16:22:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-18T16:41:07.000Z (over 1 year ago)
• Last Synced: 2024-11-09T08:29:52.802Z (2 months ago)
• Topics: bcryptjs, dayjs, docker, e2e-tests, eslint, fastify, jwt, nodejs, postgresql, prisma, supertest, typescript, unit-testing, vitest, zod
• Language: TypeScript
• Homepage:
• Size: 107 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GymPass style app

Uma aplicação de exemplo que simula funcionalidades básicas de um app de academia.

## Requisitos Funcionais (RFs)

- [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 seu histórico de check-ins;

- [x] Deve ser possível o usuário buscar academias próximas (até 10 km);

- [x] Deve ser possível o usuário busca 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.

## Regras de Negócio (RNs)

- [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 criado;

- [x] O check-in só pode ser validado por administradores;

- [x] A academia só pode ser cadastrada por administradores.

## Requisitos Não Funcionais (RNFs)

- [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).

## Scripts

- `dev`: Roda a aplicação em modo de desenvolvimento.

- `start`: Roda a aplicação em produção, após ser compilada.

- `build`: Compila a aplicação.

## Como usar

1. Clone o repositório: `git clone https://github.com/alexandrecpedro/03-api-solid.git`

2. Instale as dependências: `npm install`

3. Inicie o servidor: `npm run dev`

4. Acesse `http://localhost:3000` para testar a API.