This repository has been archived by the owner on Dec 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from 7SOATSquad30/feature/Docker
doc: start documentation
- Loading branch information
Showing
1 changed file
with
40 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,45 @@ | ||
# fastfood | ||
# FastFood Application | ||
|
||
## Requirements | ||
FastFood é uma aplicação de gerenciamento de pedidos de fast food. A aplicação foi desenvolvida usando Java, Spring Boot, Gradle e SQL. | ||
|
||
- Java JDK 21 | ||
## Requisitos | ||
|
||
## How to run | ||
- Java JDK 21 | ||
- Gradle | ||
- PostgreSQL | ||
|
||
build | ||
``` | ||
./gradlew build | ||
``` | ||
## Como executar a aplicação | ||
|
||
run | ||
``` | ||
./gradlew bootRun | ||
``` | ||
### Construir a aplicação | ||
|
||
Para construir a aplicação, execute o seguinte comando no diretório raiz do projeto: | ||
|
||
### Executar a aplicação | ||
|
||
Para executar a aplicação, execute o seguinte comando no diretório raiz do projeto: | ||
|
||
## Estrutura do banco de dados | ||
|
||
A aplicação usa um banco de dados PostgreSQL. O esquema do banco de dados inclui as seguintes tabelas: | ||
|
||
- `tb_coupon`: Armazena informações sobre cupons de desconto. | ||
- `tb_product`: Armazena informações sobre os produtos disponíveis. | ||
- `tb_customer`: Armazena informações sobre os clientes. | ||
- `tb_order`: Armazena informações sobre os pedidos dos clientes. | ||
- `tb_order_payment`: Armazena informações sobre os pagamentos dos pedidos. | ||
- `tb_order_item`: Armazena informações sobre os itens dos pedidos. | ||
|
||
O script SQL para criar essas tabelas está disponível no arquivo `init.sql`. | ||
|
||
## Importação de dados | ||
|
||
A aplicação inclui um script SQL para importar dados de exemplo para o banco de dados. O script está disponível no arquivo `import.sql` e inclui dados de exemplo para as tabelas `tb_product` e `tb_customer`. | ||
|
||
## 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: | ||
docker-compose up |