Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/santospatrick/gympoint-backend

💪 Gym management application (registrations/check-ins)
https://github.com/santospatrick/gympoint-backend

Last synced: about 1 month ago
JSON representation

💪 Gym management application (registrations/check-ins)

Awesome Lists containing this project

README

        

# gympoint-backend
Desafio do app "Gympoint" do curso GoStack da Rockseat

## Índice
- [Setup](#setup)
- [VSCode (Debug)](#vscode-debug)
- [Insomnia](#Insomnia)

## Setup
1. Suba um banco `postgres` e um banco `redis` (preferível com `docker`)
```bash
docker run --name database -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres:11
docker run --name redisgympoint -p 6379:6379 -d -t redis:alpine
```

2. Crie uma database chamada `gympoint` e aponte corretamente seu nome no `.env`

3. Crie uma conta no [mailtrap](mailtrap.io) e um inbox. Após finalizar, copie suas credenciais e preencha as variáveis `MAIL_HOST, MAIL_PORT, MAIL_USER e MAIL_PASS` no `.env`

4. Configure o arquivo `.env` corretamente (preenchendo as variáveis encontradas no `.env.example`)

5. Preencha o banco com dados padrão
```bash
yarn sequelize db:seed:all
```

6. Rode os seguintes comandos:
```bash
yarn
yarn dev

# Para iniciar fila de e-mails no redis
yarn queue
```

## VSCode (Debug)

1. Rode o seguinte comando para subir o servidor
```
yarn dev:debug
```

2. Depois inicie uma sessão de debug no vscode

![VSCode debug](docs/debug.png)

## Insomnia
1. [Baixe aqui](https://raw.githubusercontent.com/santospatrick/gympoint-backend/master/json/insomnia.json) o arquivo .json do projeto do Insomnia para testar as requisições

2. Importe a collection dentro do Insomnia

3. Crie as variáveis `base_url e token` no ambiente do Insomnia

![Ambiente Insomnia](docs/insomnia-ambiente.png)

![Variáveis Insomnia](docs/insomnia-variaveis.png)