Skip to content

Commit

Permalink
feat: imp readme, docker compose
Browse files Browse the repository at this point in the history
  • Loading branch information
c_jean.silva committed Jul 31, 2024
1 parent 9199146 commit c15067c
Show file tree
Hide file tree
Showing 7 changed files with 714 additions and 635 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ As informações dispostas no sistema de pedidos precisarão ser gerenciadas pel

## Manual/Documentação de funcionalidade (Swagger/Open API) :heavy_check_mark:

[Clique aqui para ser redirecionado para documentação das funcionalidade](https://github.com/fiap-8soat-tc-one/tc-backend/blob/feature/review-readme/docs/api/README.md)
- **Para todos os endpoints privado se faz necessário gerar o token via endpoint login**
[Clique aqui para ser redirecionado para documentação das funcionalidade](https://documenter.getpostman.com/view/7393190/2sA3kd9cgG)

## Domain Storytelling :heavy_check_mark:

Expand All @@ -92,4 +93,9 @@ As informações dispostas no sistema de pedidos precisarão ser gerenciadas pel

## Domain Mapping :heavy_check_mark:

![image](https://github.com/fiap-8soat-tc-one/tc-backend/blob/feature/review-readme/assets/domain-mapping.drawio.png)
![image](https://github.com/fiap-8soat-tc-one/tc-backend/blob/feature/review-readme/assets/domain-mapping.drawio.png)

## Requisitos não funcionais que seram implementados no futuro

- Testes de Unidade.
- Fluxo de cadastro de usuários administrativos, hoje está fixo apenas um, via carga de banco pelo flyway.
7 changes: 6 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ services:
DATABASE_PASS: ${POSTGRES_PASSWORD}
DATABASE_PORT: 5432
DATABASE_NAME: ${POSTGRES_DB}

healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:8080/api/public/v1/health"]
interval: 30s
timeout: 10s
retries: 3
start_period: 10s
volumes:
pgdata:
external: false
35 changes: 0 additions & 35 deletions docs/api/README.md

This file was deleted.

Loading

0 comments on commit c15067c

Please sign in to comment.