Skip to content

Commit 3d1bf76

Browse files
author
Guilherme Biff Zarelli
committed
docs: readme images
1 parent 2d69dac commit 3d1bf76

File tree

6 files changed

+23
-5
lines changed

6 files changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
![Forks](https://img.shields.io/github/forks/helpdeveloper/java-modular-architecture.svg)
33
![Stars](https://img.shields.io/github/stars/helpdeveloper/java-modular-architecture.svg)
44
![Release Version](https://img.shields.io/github/release/helpdeveloper/java-modular-architecture.svg)
5-
![WorkFlow](https://github.com/helpdeveloper/java-modular-architecture/workflows/Java%20CI%20with%20Maven/badge.svg)
5+
![WorkFlow](https://github.com/helpdeveloper/java-modular-architecture/workflows/Java%20CI%20with%20Maven/badge.svg)
66
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d492d9f4f03941f1aadfb4094536ef76)](https://www.codacy.com/gh/helpdeveloper/java-modular-architecture/dashboard?utm_source=github.com&utm_medium=referral&utm_content=helpdeveloper/java-modular-architecture&utm_campaign=Badge_Grade)
77
[![Coverage Status](https://coveralls.io/repos/github/helpdeveloper/java-modular-architecture/badge.svg?branch=main)](https://coveralls.io/github/helpdeveloper/java-modular-architecture?branch=main)
88
# Arquitetura modular
99

10-
O objetivo do bom design de software, como já diria Robert C. Martin, em seu livro 'Clean Architecture: A Craftsman's Guide to Software Structure and Design', é minimizar os recursos humanos necessários para construir e manter um determinado sistema.
10+
O objetivo do bom design de software, como já diria Robert C. Martin, em seu livro 'Clean Architecture: A Craftsman's Guide to Software Structure and Design', é minimizar os recursos humanos necessários para construir e manter um determinado sistema.
1111

1212
Esse projeto é inspirado em situações e dificuldades reais já vivenciadas que nos permitiu ter uma visão um pouco mais abrangente sobre como ter e construir uma arquitetura duradoura. "The only way to go fast, is to go well." - Robert C. Martin
1313

@@ -70,7 +70,7 @@ 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.
73+
O Projeto conta com uma stack configurada no docker-compose completa.
7474
Fornecendo toda infraestrutura necessária para o desenvolvedor.
7575

7676
<p align="center">
@@ -108,12 +108,22 @@ docker-compose -f .docker-compose/quarkus-app.yml up
108108
```
109109

110110
## Consumindo API
111+
112+
<p align="center">
113+
<img src="./images/openapi.png" height="150">
114+
</p>
115+
111116
Para ter uma 'interface' de fácil com o OpenAPI consumido usamos o [RapiDoc](https://mrin9.github.io/RapiDoc/).
112117

113-
Basta acessar [Endereço local](http://localhost:5000) e já pode testar as APIs
118+
Basta acessar [Endereço local](http://localhost:5000) e já pode testar as APIs
114119
- http://localhost:5000
115120

116121
## Rodando teste de carga
122+
123+
<p align="center">
124+
<img src="./images/k6.png" height="150">
125+
</p>
126+
117127
Para quem ainda não conhece o [k6](https://k6.io/) é uma ferramenta para testes de carga, basta [Instalar o K6](https://k6.io/docs/getting-started/installation) e executar o comando:
118128

119129
```bash
@@ -127,17 +137,25 @@ O tempo de execução do K6 e quantidade de 'execuções' é configurável, bast
127137
### Observabilidade
128138
Saber como a aplicação está se comportando e métricas
129139

140+
<p align="center">
141+
<img src="./images/grafana.png" height="150">
142+
</p>
143+
130144
A combinação poderosa entre o [Grafana](https://grafana.com/) e o [Prometheus](https://prometheus.io/) permite gráficos e alerta configuráveis.
131145
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.
132146
- http://localhost:3000
133147
- login: *admin*
134148
- senha: *admin*
135-
149+
136150
Já o [Promehteus Local](http://localhost:9090) só acessar o link (sem login):
137151
- http://localhost:9090
138152

139153
### Acessando o banco de dados
140154

155+
<p align="center">
156+
<img src="./images/adminer.png" height="150">
157+
</p>
158+
141159
Ao acessar o [Adminer](http://localhost:5000/adminer) é possível executar 'scripts' SQL além de adicionar e alterar dados dentro das tabelas.
142160
- http://localhost:5000/adminer
143161
- servidor: *sampledb*

images/adminer.png

-31.8 KB
Loading

images/grafana.png

-48.4 KB
Loading

images/k6.png

-65.8 KB
Loading

images/openapi.png

-9.1 KB
Loading

images/prometheus.png

10.1 KB
Loading

0 commit comments

Comments
 (0)