From 7d6699cb36bdab72fb811d6ac14a5eecffff1c03 Mon Sep 17 00:00:00 2001 From: Murilo Kakazu Date: Tue, 28 May 2024 01:36:35 -0300 Subject: [PATCH 1/3] docs: update docs including domain model link --- Makefile | 10 +++- README.md | 48 +++++++++++-------- docker-compose.yml | 4 +- src/main/resources/application-dev.properties | 2 +- 4 files changed, 38 insertions(+), 26 deletions(-) diff --git a/Makefile b/Makefile index d256ab1..4213ef9 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,10 @@ -.PHONY: test build run debug lint/fix +.PHONY: test build run debug lint/fix infrastructure/up + +infrastructure/up: + docker-compose up -d database + +down: + docker-compose down --remove-orphans database test: ./gradlew test @@ -7,7 +13,7 @@ build: ./gradlew build run: - ./gradlew bootRun + docker-compose up api debug: ./gradlew bootRun --debug-jvm diff --git a/README.md b/README.md index 66fb488..50e7533 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,42 @@ FastFood é uma aplicação de gerenciamento de pedidos de fast food. A aplicação foi desenvolvida usando Java, Spring Boot, Gradle e SQL. +## Documentação + +### Modelo do Domínio - Event Storm + +O modelo do domínio é mantido e atualizado aqui: +https://miro.com/app/board/uXjVKWnjhHY=/?share_link_id=867288089876 + ## Requisitos - Java JDK 21 - Gradle -- PostgreSQL +- Docker & Docker Compose +- Make ## Como executar a aplicação -### Construir a aplicação +### Subindo a infraestrutura +```sh +make infrastucture/up +``` -Para construir a aplicação, execute o seguinte comando no diretório raiz do projeto: +### Build +```sh +make build +``` -### Executar a aplicação +### Executando a aplicação +```sh +make run +``` +Para parar a aplicação, basta apertar CTRL+C no terminal (SIGINT) -Para executar a aplicação, execute o seguinte comando no diretório raiz do projeto: +### Derrubar a infraestrutura +``` +make down +``` ## Estrutura do banco de dados @@ -37,19 +58,4 @@ A aplicação inclui um script SQL para importar dados de exemplo para o banco d ## Docker -A aplicação inclui um `Dockerfile` para construir uma imagem Docker da aplicação, e um arquivo `docker-compose.yml` para executar a aplicação e o banco de dados PostgreSQL em containers Docker. - -Para construir a imagem Docker da aplicação, execute o seguinte comando no diretório raiz do projeto: - -Para executar a aplicação e o banco de dados PostgreSQL em containers Docker, execute o seguinte comando no diretório raiz do projeto, nesta sequência: - - -./gradleW build - -docker compose build - -docker-compose up - -Caso queira parar a execução dos containers, execute o seguinte comando no diretório raiz do projeto: - -docker compose down --remove-orphans \ No newline at end of file +A aplicação inclui um `Dockerfile` para construir uma imagem Docker da aplicação, e um arquivo `docker-compose.yml` para executar a aplicação e o banco de dados PostgreSQL em containers Docker. \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 328cd2e..877d3d0 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ version: '3.9' services: - local-postgres: + database: image: postgres environment: POSTGRES_URL: "jdbc:postgresql://localhost:5432/fastfood" @@ -18,7 +18,7 @@ services: api: depends_on: - - local-postgres + - database build: . environment: SPRING_PROFILES_ACTIVE: "dev" diff --git a/src/main/resources/application-dev.properties b/src/main/resources/application-dev.properties index 26346ea..1b62646 100644 --- a/src/main/resources/application-dev.properties +++ b/src/main/resources/application-dev.properties @@ -1,5 +1,5 @@ # DATASOURCE -spring.datasource.url=jdbc:postgresql://local-postgres:5432/fastfood +spring.datasource.url=jdbc:postgresql://database:5432/fastfood spring.datasource.username=postgres spring.datasource.password=123456 From a198e3e5ee7b52cb8bfb2b5f07b4d3586101a6d1 Mon Sep 17 00:00:00 2001 From: Murilo Kakazu Date: Tue, 28 May 2024 01:37:29 -0300 Subject: [PATCH 2/3] docs: add code lang --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 50e7533..710b638 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ make run Para parar a aplicação, basta apertar CTRL+C no terminal (SIGINT) ### Derrubar a infraestrutura -``` +```sh make down ``` From 7f070624287e718df8882410e76c3b0e7aa1f957 Mon Sep 17 00:00:00 2001 From: Murilo Kakazu Date: Tue, 28 May 2024 01:39:33 -0300 Subject: [PATCH 3/3] docs: add swagger link --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 710b638..1a56a7b 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,9 @@ make run ``` Para parar a aplicação, basta apertar CTRL+C no terminal (SIGINT) +A aplicação subirá na porta 8080, e a documentação das rotas pode ser acessada via swagger: +http://localhost:8080/swagger-ui/index.html + ### Derrubar a infraestrutura ```sh make down