Skip to content
This repository has been archived by the owner on Dec 4, 2024. It is now read-only.

Commit

Permalink
docs: update docs including domain model link
Browse files Browse the repository at this point in the history
  • Loading branch information
MuriloKakazu committed May 28, 2024
1 parent b72479e commit 7d6699c
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 26 deletions.
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -7,7 +13,7 @@ build:
./gradlew build

run:
./gradlew bootRun
docker-compose up api

debug:
./gradlew bootRun --debug-jvm
Expand Down
48 changes: 27 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
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.
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '3.9'

services:
local-postgres:
database:
image: postgres
environment:
POSTGRES_URL: "jdbc:postgresql://localhost:5432/fastfood"
Expand All @@ -18,7 +18,7 @@ services:

api:
depends_on:
- local-postgres
- database
build: .
environment:
SPRING_PROFILES_ACTIVE: "dev"
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application-dev.properties
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 7d6699c

Please sign in to comment.