Skip to content

Commit a05dbde

Browse files
committed
docs: adjust readme
1 parent 5f3053a commit a05dbde

1 file changed

Lines changed: 13 additions & 21 deletions

File tree

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ Ideal para demonstrar conceitos de mensageria, arquitetura desacoplada e resili
1212

1313
---
1414

15+
## 📊 Endereços Úteis do Projeto
16+
17+
### 🌐 **Live Demo (Deploy no Render)**
18+
A API está publicada e disponível publicamente nos links abaixo:
19+
- **API Principal (Metadados em JSON)**: [https://queueapi-nestjs.onrender.com/](https://queueapi-nestjs.onrender.com/)
20+
- **Documentação da API (Scalar)**: [https://queueapi-nestjs.onrender.com/docs](https://queueapi-nestjs.onrender.com/docs)
21+
- **Dashboard de Filas (Bull Board)**: [https://queueapi-nestjs.onrender.com/admin/queues](https://queueapi-nestjs.onrender.com/admin/queues)
22+
23+
> [!NOTE]
24+
> **Aviso sobre Cold Start**: Por estar hospedada no plano gratuito da Render, a aplicação entra em suspensão após um período de inatividade. A primeira requisição após isso pode levar em torno de 50 segundos para responder devido à inicialização fria da máquina virtual.
25+
26+
---
27+
1528
## 🏗️ Arquitetura do Sistema
1629

1730
O fluxo de processamento funciona de maneira totalmente assíncrona, desacoplando o recebimento da requisição HTTP do processamento pesado:
@@ -121,27 +134,6 @@ pnpm run start:dev
121134

122135
---
123136

124-
## 📊 Endereços Úteis do Projeto
125-
126-
### 🌐 **Live Demo (Deploy no Render)**
127-
A API está publicada e disponível publicamente nos links abaixo:
128-
- **API Principal (Metadados em JSON)**: [https://queueapi-nestjs.onrender.com/](https://queueapi-nestjs.onrender.com/)
129-
- **Documentação da API (Scalar)**: [https://queueapi-nestjs.onrender.com/docs](https://queueapi-nestjs.onrender.com/docs)
130-
- **Dashboard de Filas (Bull Board)**: [https://queueapi-nestjs.onrender.com/admin/queues](https://queueapi-nestjs.onrender.com/admin/queues)
131-
132-
> [!NOTE]
133-
> **Aviso sobre Cold Start**: Por estar hospedada no plano gratuito da Render, a aplicação entra em suspensão após um período de inatividade. A primeira requisição após isso pode levar em torno de 50 segundos para responder devido à inicialização fria da máquina virtual.
134-
135-
---
136-
137-
### 📄 **Documentação da API Local (Scalar)**
138-
Acesse [http://localhost:3000/docs](http://localhost:3000/docs) para interagir com os endpoints da API localmente por meio de uma interface moderna e bonita.
139-
140-
### 📈 **Dashboard de Filas Local (Bull Board)**
141-
Acesse [http://localhost:3000/admin/queues](http://localhost:3000/admin/queues) para inspecionar visualmente os jobs ativamente em processamento local, completados ou falhos.
142-
143-
---
144-
145137
## 🧪 Testes Automatizados
146138
O projeto conta com suíte de testes unitários para validar a lógica de criação, deleção e leitura de status dos jobs:
147139

0 commit comments

Comments
 (0)