Skip to content

Commit 9bca61e

Browse files
author
Guilherme Biff Zarelli
committed
doc: readme
1 parent f646a62 commit 9bca61e

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Determina o comportamento da funcionalidade exigida, no caso, o use case será o
2828
## Adaptadores
2929

3030
### input
31-
Camada de apresentação do sistema, nela, por exemplo, iremos fornecer nossos end points.
31+
Camada de apresentação do sistema, nela, por exemplo, iremos fornecer nossos end-points.
3232

3333
### output
34-
Todo acesso a dados seja banco e/ou api's expostos pelas interfaces do Use Case devem ser implementadas nessa camada.
34+
Todo acesso a dados seja banco e/ou api's expostos pelas 'interfaces' do Use Case devem ser implementadas nessa camada.
3535

3636
## Testabilidade
3737

@@ -70,18 +70,26 @@ Teste do ponto de vista de quem irá consumir, sempre buscando o mais perto de p
7070

7171
# Executando o projeto
7272

73+
O Projeto conta com uma stack configurada no docker-compose completa.
74+
Fornecendo toda infraestrutura necessária para o desenvolvedor.
75+
76+
<p align="center">
77+
<img src="./images/stack.png" height="250">
78+
</p>
79+
7380
### Requerido
7481

7582
- Java 11+
7683
- Maven 3+
7784
- docker
7885
- docker-compose
7986

80-
## Build do projeto, já toda todos os teste unitários e os testes de aceitação
87+
## Build do projeto, já com todos os testes unitários e os testes de aceitação
8188

8289
```bash
8390
mvn clean install
8491
```
92+
8593
## Gerando imagem docker com o Quarkus
8694
```bash
8795
docker build -t helpdev/app-quarkus-jvm .
@@ -93,13 +101,14 @@ docker build -t helpdev/app-quarkus-jvm .
93101
```bash
94102
docker-compose -f .docker-compose/stack.yml up
95103
```
104+
96105
*Agora podemos iniciar nossa aplicação*
97106
```bash
98107
docker-compose -f .docker-compose/quarkus-app.yml up
99108
```
100109

101110
## Consumindo API
102-
Para ter uma interface de fácil com o OpenAPI consumido usamos o [RapiDoc](https://mrin9.github.io/RapiDoc/).
111+
Para ter uma 'interface' de fácil com o OpenAPI consumido usamos o [RapiDoc](https://mrin9.github.io/RapiDoc/).
103112

104113
Basta acessar [Endereço local](http://localhost:5000) e já pode testar as APIs
105114
- http://localhost:5000
@@ -111,15 +120,15 @@ Para quem ainda não conhece o [k6](https://k6.io/) é uma ferramenta para teste
111120
k6 run k6/script.js
112121
```
113122

114-
O tempo de execução do K6 e quantidade de "Execuções" é configuravel, basta alterar o arquivo [Script do K6](/k6/script.js)
123+
O tempo de execução do K6 e quantidade de 'execuções' é configurável, basta alterar o [Script do K6](/k6/script.js).
115124

116125
## Monitorando aplicação
117126

118127
### Observabilidade
119128
Saber como a aplicação está se comportando e métricas
120129

121-
A combinação poderosa entre o [Grafana](https://grafana.com/) e o [Prometheus](https://prometheus.io/) permite gráficos e alertas configuraveis.
122-
Acesssando o [Grafana Local](http://localhost:3000) já basta navegar até o dashboard précadastro e ter uma amostrado dos dados da apliação e das ferramentas.
130+
A combinação poderosa entre o [Grafana](https://grafana.com/) e o [Prometheus](https://prometheus.io/) permite gráficos e alerta configuráveis.
131+
Acessando o [Grafana Local](http://localhost:3000) já basta navegar até o dashboard précadastro e ter uma amostrado dos dados da aplicação e das ferramentas.
123132
- http://localhost:3000
124133
- login: admin
125134
- senha: admin
@@ -129,7 +138,7 @@ Já o [Promehteus Local](http://localhost:9090) só acessar o link (sem login):
129138

130139
### Acessando o banco de dados
131140

132-
Ao acessar o [Adminer](http://localhost:5000/adminer) é possivel executar scripts SQL além de adicionar e altarer dados dentro das tabelas.
141+
Ao acessar o [Adminer](http://localhost:5000/adminer) é possível executar 'scripts' SQL além de adicionar e alterar dados dentro das tabelas.
133142
- http://localhost:5000/adminer
134143
- host:
135144
- usuário:

images/stack.png

135 KB
Loading

0 commit comments

Comments
 (0)