https://github.com/didifive/quickcup-api
Quickcup Backend API made with Java, Spring Boot, Thymeleaf and Postgres
https://github.com/didifive/quickcup-api
api api-rest apikey-authentication basic-authentication flyway java postgresql spring-boot spring-data-jpa spring-security thymeleaf thymeleaf-layout
Last synced: 5 months ago
JSON representation
Quickcup Backend API made with Java, Spring Boot, Thymeleaf and Postgres
- Host: GitHub
- URL: https://github.com/didifive/quickcup-api
- Owner: didifive
- License: apache-2.0
- Created: 2024-11-02T14:26:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-25T02:55:14.000Z (about 1 year ago)
- Last Synced: 2025-01-10T00:17:14.962Z (about 1 year ago)
- Topics: api, api-rest, apikey-authentication, basic-authentication, flyway, java, postgresql, spring-boot, spring-data-jpa, spring-security, thymeleaf, thymeleaf-layout
- Language: Java
- Homepage: https://quickcup-api.zancanela.dev.br/
- Size: 7.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/didifive/quickcup-api/commits/main)
[](https://luiszancanela.dev.br/)
[](https://www.jetbrains.com/idea/)
# QuickCup API ā
API Back-end com Java e Spring Boot e Front-end Administrativo com Thymeleaf para delivery de uma cafeteria.
## šÆ Objetivo
Este aplicativo foi criado atravƩs da oportunidade do desafio do trabalho semestral da
faculdade UNIFRAN / Cruzeiro do Sul, Projeto Integrador Transdisciplinar, do segundo
semestre de 2024. Todo o conteĆŗdo Ć© fictĆcio.
O defasio consistia em desenvolver um sistema para gerenciamento de delivery para uma cafeteria.
Para a soluĆ§Ć£o, foi criado o sistema QuickCup com dois mĆ³dulos:
- QuickCup API e ADMIN: O QuickCup API e Admin Ć© essa aplicaĆ§Ć£o e interface desenvolvida para o acesso da loja poder cadastrar os produtos e visualizar os pedidos realizados pelo consumidor. Nessa aplicaĆ§Ć£o foram criados endpoints API REST para que o QuickCup App possa interagir com o QuickCup API.
O QuickCup Admin foi produzido para ser responsivo, mas para uma melhor experiĆŖncia Ć© ideal acessar com notebook ou computador. (Esse repositĆ³rio contĆ©m o QuickCup API e Admin)
- QuickCup APP: O QuickCup App foi desenvolvido com React e Bootstrap CSS para trazer experiĆŖncia de responsividade para acesso por via de diversos dispositivos mobiles ou notebooks e computadores. Link para o repositĆ³rio do APP: [didifive/quickcup-app](https://github.com/didifive/quickcup-app)
## š§ Principais Tecnologias
- Java 17
- Maven
- Spring Boot 3.3.5
- Spring Web
- Spring Data JPA
- PostgreSQL
- Flyway
- Thymeleaf
- Docker e Docker Compose 3 para desenvolvimento local com postgres
- IntelliJ IDEA
## š£ Diagramas
Os diagramas foram criados na sintaxe [Mermaid](https://mermaid.live/).
### Diagrama de Classes
```mermaid
classDiagram
class BasicEntity {
<>
- Long id
+ getId()
+ setId()
}
class Empresa {
- Short id
- String nome
- String email
- String telefone
- BigDecimal valorEntrega
- Time tempoEntrega
- String cep
- String logradouro
- Integer numero
- String complemento
- String bairro
- String cidade
- String estado
- BigDecimal longitude
- BigDecimal latitude
+ Getters() and Setters()
}
class Cliente {
- String nome
- String telefone
- List~Endereco~ enderecos
+ Getters() and Setters()
}
class Endereco {
- Long clienteId
- String nome
- String cep
- String logradouro
- Integer numero
- String complemento
- String bairro
- String cidade
- String estado
- BigDecimal longitude
- BigDecimal latitude
+ Getters() and Setters()
}
class Grupo {
- String nome
- String descricao
- List~Produto~ produtos
+ Getters() and Setters()
}
class Produto {
- String codigo
- String nome
- String descricao
- String imagem
- BigDecimal valorOriginal
- BigDecimal valorDesconto
- boolean enabled
- Grupo grupo
+ Getters() and Setters()
}
class PedidoStatus {
<>
NOVO
CONFIRMADO
CANCELADO
EM_PREPARO
EM_ENTREGA
FINALIZADO
}
class FormaPagamento {
<>
DINHEIRO
CARTAO_CREDITO
CARTAO_DEBITO
PIX
}
class Pedido {
- Cliente cliente
- PedidoStatus status
- BigDecimal valorEntrega
- boolean retira
- String endereco
- FormaPagamento formaPagamento
- String observacoes
- Instant dataHoraPedido
- List~ItemPedido~ itens
+ Getters() and Setters()
}
class ItemPedidoId {
<>
- Pedido pedido
- Produto produto
+ ItemPedidoId()
+ ItemPedidoId(Pedido, Produto)
+ Getters() and Setters()
+ hashCode()
+ equals()
}
class ItemPedido {
- ItemPedidoId id
- Integer quantidade
- BigDecimal valorUnitarioOriginal
- BigDecimal valorUnitarioDesconto
+ Getters() and Setters()
}
class DiaSemana {
<>
DOMINGO
SEGUNDA
TERCA
QUARTA
QUINTA
SEXTA
SABADO
+ from(DayOfWeek)
}
class Funcionamento {
- DiaSemana diaSemana
- Time horaInicio
- Time horaFim
+ Getters() and Setters()
}
class FuncionamentoEspecialTipo {
<>
ABERTO
FECHADO
}
class FuncionamentoEspecial {
- String nome
- Instant dataInicio
- Instant dataFim
- FuncionamentoEspecialTipo tipo
+ Getters() and Setters()
}
Cliente -- BasicEntity : herda
Endereco -- BasicEntity : herda
Grupo -- BasicEntity : herda
Produto -- BasicEntity : herda
Pedido -- BasicEntity : herda
FuncionamentoEspecial -- BasicEntity : herda
Pedido -- PedidoStatus : contƩm
Pedido -- FormaPagamento : contƩm
Cliente "1" -- "0..*" Endereco : possui
Grupo "1" -- "0..*" Produto : contƩm
Pedido "1" -- "0..*" Cliente : pertence
ItemPedidoId "1" -- "1" ItemPedido : inclui
ItemPedido "1" -- "0..*" Pedido : inclui
Funcionamento -- DiaSemana : possui
FuncionamentoEspecial -- FuncionamentoEspecialTipo : possui
```
### Diagrama de Sequencia
```mermaid
sequenceDiagram
actor Cliente
participant Aplicativo
participant API
actor Atendente
Cliente->>+Aplicativo: Cliente acessa aplicativo
Aplicativo->>+Cliente: Loja em funcionamento disponibiliza menu
Cliente->>+Aplicativo: Escolhe item do menu
Cliente->>+Aplicativo: Adiciona produto com quantidade ao carrinho
Aplicativo->>+Cliente: Retorna tela do carrinho
Cliente->>+Aplicativo: Informa nome e telefone
Cliente->>+Aplicativo: Informa opĆ§Ć£o de entrega e endereƧo
Cliente->>+Aplicativo: Informa modo de pagamento
Cliente->>+Aplicativo: Faz o pedido
Aplicativo->>+API: Encaminha o pedido
API->>+Aplicativo: Retorna pedido efetuado
API->>+Atendente: Informa pedido novo
Atendente->>+API: Atualiza status pedido
Cliente->>+Aplicativo: Consulta pedido
Aplicativo->>+API: Consulta Status Pedido
API->>+Aplicativo: Retorna Status Pedido
Aplicativo->>+Cliente: Informa status pedido
```
### Diagrama de Entidade e Relacionamento
```mermaid
erDiagram
EMPRESA {
SMALLINT id PK
VARCHAR nome
VARCHAR email
VARCHAR telefone
DECIMAL valor_entrega
TIME tempo_entrega
VARCHAR cep
VARCHAR logradouro
INTEGER numero
VARCHAR complemento
VARCHAR bairro
VARCHAR cidade
VARCHAR estado
DECIMAL longitude
DECIMAL latitude
}
CLIENTE {
BIGINT id PK
VARCHAR nome
VARCHAR telefone
}
ENDERECO {
BIGINT id PK
BIGINT cliente_id FK
VARCHAR nome
VARCHAR cep
VARCHAR logradouro
INTEGER numero
VARCHAR complemento
VARCHAR bairro
VARCHAR cidade
VARCHAR estado
DECIMAL longitude
DECIMAL latitude
}
GRUPO {
BIGINT id PK
VARCHAR nome
VARCHAR descricao
}
PRODUTO {
BIGINT id PK
VARCHAR codigo
VARCHAR nome
VARCHAR descricao
VARCHAR imagem
DECIMAL valor_original
DECIMAL valor_desconto
BOOLEAN enabled
BIGINT grupo_id FK
}
PEDIDO {
BIGINT id PK
BIGINT cliente_id FK
VARCHAR status
DECIMAL valor_entrega
BOOLEAN retira
VARCHAR endereco
VARCHAR forma_pagamento
VARCHAR observacoes
TIMESTAMP data_hora_pedido
}
ITEM_PEDIDO {
BIGINT pedido_id PK
BIGINT produto_id PK
INTEGER quantidade
DECIMAL valor_unitario_original
DECIMAL valor_unitario_desconto
}
FUNCIONAMENTO {
VARCHAR dia_semana PK
TIME hora_inicio
TIME hora_fim
}
FUNCIONAMENTO_ESPECIAL {
BIGINT id PK
VARCHAR nome
TIMESTAMP data_inicio
TIMESTAMP data_fim
VARCHAR tipo
}
CLIENTE ||--|{ ENDERECO : possui
GRUPO ||--o{ PRODUTO : "contƩm"
PEDIDO ||--o| CLIENTE : pertence
ITEM_PEDIDO ||--o| PEDIDO : inclui
ITEM_PEDIDO ||--|{ PRODUTO : "contƩm"
%% Triggers
ITEM_PEDIDO ||--|{ prevent_delete_or_update_item_pedido_trigger : "prevenĆ§Ć£o de delete/update"
PEDIDO ||--|{ prevent_delete_pedido_trigger : "prevenĆ§Ć£o de delete"
PEDIDO ||--|{ allow_update_status_only_trigger : "permitir update apenas no status"
```
-----
## š· Prints do Projeto
### š„ DemonstraĆ§Ć£o de Telas e Funcionamento
### Spring banner personalizado
### Tela Inicial do QuickCup Admin
### Tela Atendimento Pedidos
### Menu e InstruƧƵes conforme nĆvel de acesso
#### Menu sem logar
#### Tela de Login
#### Perfil Admin
#### Perfil Atendente
#### Perfil Dev
### Swagger QuickCup API
### JaCoCo Coverage
### VariƔveis de Ambiente configuradas no Railway:
-----
## āļø Testes
Os testes foram feitos utilizando JUnit 5, Mockito e MockMVC com Hamcrest.
Para executar os testes pode executar sua IDE ou
Utilizando o terminal (PowerShell, Bash ou similiar), basta executar na pasta do projeto o comando abaixo:
```
./mvnw clean verify -Dspring.profiles.active=test
```
-----
## ā Executando o projeto localmente
Antes de mais nada, Ć© preciso possuir no mĆnimo JDK 21 LTS instalado na mĆ”quina em que
irĆ” executar. A execuĆ§Ć£o do projeto pode ser feita utilizando recurso de sua IDE ou
com comando (demonstrado no prĆ³ximo item).
### š VariĆ”veis de Ambiente
Antes de executar Ć© preciso ter atenĆ§Ć£o e configurar as variĆ”veis de ambiente:
- `SPRING_PROFILES_ACTIVE`: Ambiente de desenvolvimento ou produĆ§Ć£o
- `PGHOST`: Host Postgres
- `PGPORT`: Porta Postgres
- `PGDATABASE`: Nome do database Postgres
- `POSTGRES_USER`: UsuƔrio Postgres
- `POSTGRES_PASSWORD`: Senha Postgres
- `QUICKCUP_API_KEY`: Chave de acesso da API
- `QUICKCUP_USERS_DEFAULT_PASSWORD`: Senha padrĆ£o para os usuĆ”rios do painel administrativo
- `CROSS_ORIGIN_URLS`: URLs para configurar o CORS para acesso de aplicativos externos aos endpoints REST API
- `LINK_FORMULARIO_TESTES`: URL para acessar o formulĆ”rio de testes (para carregar no index do painel administrativo, nĆ£o afeta o funcionamento da aplicaĆ§Ć£o)
- `LINK_APLICACAO_CLIENTE`: URL para acessar a aplicaĆ§Ć£o do cliente (para carregar no index do painel administrativo, nĆ£o afeta o funcionamento da aplicaĆ§Ć£o)
Para facilitar eu deixei o arquivo `.env.sample` com as variĆ”veis de ambiente. Basta renomear para `.env` para que a aplicaĆ§Ć£o
carregue as informaƧƵes das variƔveis de ambiente.
#### š VariĆ”veis de Ambiente no Railway
Para a aplicaĆ§Ć£o hospedada no Railway, alĆ©m de definir as variĆ”veis de ambiente mĆnimas para a aplicaĆ§Ć£o
Ʃ necessƔrio definir a variƔvel de ambiente abaixo:
- `NIXPACKS_JDK_VERSION`: VariĆ”vel de ambiente para definir a versĆ£o do JDK, no caso desse projeto Ć© `21`.
### š Postgres Docker Compose
Essa aplicaĆ§Ć£o depende do Postgres para funcionar, acima existem variĆ”veis de ambiente para configurar o acesso ao banco de dados.
Caso jƔ possua um banco de dados Postgres, basta ajustar as variƔveis de ambiente para acessƔ-lo.
Nesse projeto utilizamos o Postgres Docker Compose para facilitar a execuĆ§Ć£o do projeto localmente sem necessitar de ter o Postgres instalado
ou configurado. Para executar o Postgres Docker Compose, basta executar na pasta do projeto o comando abaixo:
```
docker compose up
```
O docker compose tambĆ©m estĆ” preparado para ler as informaƧƵes do arquivo `.env` mencionado no item anterior, isso facilita a integraĆ§Ć£o da
aplicaĆ§Ć£o com o banco de dados jĆ” que ambas utilizando variĆ”veis de ambiente em comum.
No docker compose `docker-compose.yml` tambƩm foi configurado para subir uma instancia do pgadmin para que se possa
ter acesso visual ao banco Postgres.
### ā” Executando
Depois de configurar as variƔveis de ambiente e executar o Postgres Docker Compose (ou ter considerado as configuraƧƵes de seu Postgres), digite no terminal:
- PowerShell: `./mvnw spring-boot:run`
- Bash: `./mvnw spring-boot:run`
- CMD: `mvnw spring-boot:run`
## š OpenApi / Swagger
Quando a aplicaĆ§Ć£o estiver no ar, Ć© possĆvel acessar a documentaĆ§Ć£o da API com endpoints REST utilizando o Swagger OpenAPI v3.1 atravĆ©s do link: http://localhost:8080/swagger-ui/index.html
## šŖ Populate
Para popular dados bƔsicos no banco de dados ao iniciar o projeto, foi criada a migration do FlyWay V999__Initial_Inserts.sql.
## āļø Deploy na Nuvem
Esse projeto foi implantado no Railway que faz integraĆ§Ć£o com o repositĆ³rio do GitHub.
URL da aplicaĆ§Ć£o: https://quickcup-api.zancanela.dev.br
-----
Feito com ā¤ļø e dedicaĆ§Ć£o por [Luis Zancanela](https://github.com/didifive)