Develop

.github/workflows/maven.yml

@@ -1,8 +1,8 @@
 name: Java CI with Maven
 
 on:
-  push:
-    branches: [ '*' ]
+  # push:
+  #   branches: [ '*' ]
   pull_request:
     branches: [ '*' ]
 
@@ -41,4 +41,16 @@ jobs:
       run: |
         cd degustacao
         mvn -B package --file pom.xml
-        mvn test
+        mvn test
+
+    - name: Build and execute testes with Maven on 'bff'
+      run: |
+        cd bff
+        mvn -B package --file pom.xml
+        mvn test
+
+    - name: Build and execute testes with Maven on 'harmonizacao'
+      run: |
+        cd harmonizacao
+        mvn -B package --file pom.xml
+        mvn test

.gitignore

@@ -33,7 +33,11 @@ build/
 .vscode/
 
 ##POSTGRESQL
+.data
 cadastro/.data
 vinho/.data
 avaliacao/.data
-degustacao/.data
+degustacao/.data
+frontend/.data
+
+node_modules

README.md

@@ -1 +1,181 @@
-<h1>Projeto Vinho Notas</h1>
+# Projeto Vinho Notas App
+
+Este é o repositório do projeto `vinho-notas-app`, uma aplicação para facilitar a experiência de degustar vinhos, favorecendo a expansão e a descoberta de conhecimento de maneira organizada e estruturada.
+
+## Tecnologias Utilizadas
+
+![alt text](img/image.png)
+
+## Índice
+
+
+## Introdução
+
+<p>O vinho, uma bebida milenar apreciada por sua complexa combinação de sabores e aromas, conquista cada vez mais adeptos no Brasil. No entanto, para muitos, esse universo ainda é cercado de mistérios e desafios. Em uma definição fria, pode-se dizer que é uma bebida alcoólica obtida a partir da fermentação de uvas. Mas para quem a aprecia, vai muito além de uma simples definição. Pensando do ponto de vista de um enófilo, ela é uma mistura de sabores, aromas e texturas que permite uma verdadeira viagem em cada taça. Degustar é como atravessar o tempo e o espaço, entre a essência de uma safra e uma experiência sensorial única.</p>
+
+<p>É justamente para ajudar o apreciador de vinho amador ou ainda aquele que deseja entrar nesse mundo que se propôs a criação do Vinho Notas. Em outras palavras, para o enófilo amador que tem dificuldade em compreender os métodos e técnicas de degustação devido às complexidades envolvidas, o Vinho Notas é uma aplicação de desktop progressiva (PWA). Ele facilita a experiência de degustar e, diferentemente dos websites e aplicativos de compras, essa solução melhora a experiência na jornada de descobertas no mundo dos vinhos, ajudando a organizar e registrar as degustações, permitindo recuperar o histórico e sugerindo opções para compras futuras.</p>
+
+<p>Para construir o Vinho Notas optou-se pela metodologia ágil por ser uma abordagem ampla e flexível, com foco em valores e princípios, adotando o Scrum como framework para o desenvolvimento do projeto. Dentro dessa metodologia, optou-se por Sprints curtas, de no máximo uma semana, com meta bem definida trabalhando-se com pequenas tarefas, dando maior celeridade ao desenvolvimento do software.</p>
+
+<p>Para ajudar a organizar o trabalho de desenvolvimento, optou-se pelo Jira Software da <a href='https://www.atlassian.com/software/jira' target="_blank">Atlassian</a>. Com ele foi possível organizar e construir um quadro usando o Scrum como referência, e com isso ter uma visão mais abrangente do andamento das coisas.</p>
+
+<p>A figura abaixo apresenta o Business Model Canvas da solução, obtida a partir do template fornecido pelo <a href='https://www.strategyzer.com/library/the-business-model-canvas' target="_blank">Strategyzer</a>.</p>
+
+![alt text](img/image-1.png)
+
+## Funcionalidades
+<p>A solução toda foi pensada para ser agnóstica, ou seja, independente de qualquer plataforma ou tecnologia específica. Em outras palavras, ela não está vinculada a um sistema operacional, linguagem de programação ou ambiente de desenvolvimento específico.</p>
+<p>Para conseguir isso, optou-se pela construção de APIs (Interfaces de Programação de Aplicativos) permitindo que diferentes sistemas se comuniquem entre si de forma padronizada, independentemente das tecnologias subjacentes. Dessa forma consegui-se garantir que ela possa ser facilmente integrada a uma variedade de plataformas, sistemas e linguagens de programação, tornando-a mais agnóstica em relação às tecnologias específicas.</p>
+<p>Para dao ao usuário a experiência similar à uma aplicação desktop, optou-se pela criação de uma SPA (Single Page Application). Além disso, para garantir uma experiência ainda melhor, buscou-se a combinação da SPA com uma PWA (Progressive Web Application), permitindo assim que o Vinho Notas seja instalado tanto no computador quanto no celular do usuário.</p>
+<p>Com isso, consegui-se combinar a eficiência e a experiência do usuário de uma SPA com as vantagens adicionais de uma PWA, como capacidades offline, instalação na tela inicial e atualizações automáticas, resultando em uma experiência de usuário mais atraente e resiliente.</p>
+
+## Configuração do Projeto
+
+### Pré-requisitos
+
+- Java 17
+- Node.js e NPM
+- Docker
+
+### Configuração
+
+1. Clone o repositório para o seu ambiente local utilizando o comando git abaixo:
+``git clone https://github.com/vinho-notas/vinho-notas-app.git``
+2. Navegue até a pasta de cada um dos microsserviços e execute `mvn install` para instalar as dependências do Maven.
+3. Na pasta do frontend, execute `npm install` para instalar as dependências do Node.js.
+
+## Execução do Projeto
+
+### Executando o projeto como um todo a partir de imagens Docker
+
+<p>A meneira mais rápida de executar o projeto é iniciar os serviços utilizando as imagens disponíveis no <a href='https://hub.docker.com/u/vanderleik' target="_blank">DockerHub</a> </p>
+
+1. Navegue até a pasta raiz do projeto e abra o arquivo <a href='./docker-compose.yaml'>docker-compose.yaml</a>.
+2. Remova os comentários das linhas 67 em diante, salve o arquivo e execute o comando ``docker compose up -d`` em um terminal, certificand-se de estar com o Docker ligado. 
+
+![alt text](img/image-4.png)
+
+Ao proceder dessa forma o docker-compose.yaml se encarregará de baixar as imagens de cada microsserviço no Docker Hub e dessa forma iniciará o banco de dados PostgreSQL relacionado a cada serviço mais os back ends.
+
+
+![alt text](img/image-5.png)
+
+3. Na pasta do frontend, execute `npm install` em um terminal para instalar as dependências do Node.js.
+4. Inicie o frontend executando o comando `npm run dev` em um terminal.
+4. Agora você deve ser capaz de acessar a aplicação em <a href='http://localhost:5173' target="_blank"> `http://localhost:5173`</a>, que deve se apresentar com a seguinte aparência:
+
+![alt text](img/image-2.png)
+
+
+### Executando cada microsserviço individualmente
+Para executar o projeto, siga os passos abaixo:
+
+1. Navegue até a pasta raiz do projeto e execute o comando ``docker compose up -d`` em um terminal, certificand-se de estar com o Docker ligado. Esse comando inicia o banco de dados PostgreSQL relacionado a cada microsserviço.
+
+![alt text](img/image-3.png)
+
+2. Execute `mvn spring-boot:run` para iniciar o servidor backend de cada microsserviço.
+3. Em uma nova janela do terminal, navegue até a pasta do projeto de frontend e execute `npm run dev` para iniciar o servidor frontend.
+4. Agora você deve ser capaz de acessar a aplicação em <a href='http://localhost:5173' target="_blank"> `http://localhost:5173`</a>, que deve se apresentar com a seguinte aparência:
+
+![alt text](img/image-2.png)
+
+
+
+## Navegando pela solução
+
+### Tela inicial e cadastro
+<p>A tela inicial convida o usuário a realizar o login a fim de permitir que ele possa utilizar o sistema. Caso ele ainda não tenha usuário e senha, é convidado a se registrar, coforme figura abaixo:</p>
+
+![alt text](img/image-6.png)
+
+<p>As validações de usuário e senha que permitem a utilização do sistema estão desabilitados para possibilitar a utilização do sistema sem a necessidade de informar dados pessoais na aplicação, que serão salvos em um banco de dados.</p>
+<p>No entanto, caso queira realizar um cadastro para ver como funciona, o sistema está habilitado para aceitar os seguintes CPFs:
+
+"00000000000", "11111111111", "22222222222", "33333333333", "44444444444", "55555555555", "66666666666", "77777777777", "88888888888", "99999999999".</p>
+<p>Quailquer número de CPF que não esteja na listagem acima terá o cadastro rejeitado.</p>
+
+### Menu Vinho
+<p>O menu Vinho é composto por dois submenus: Vinhos e Avaliações.</p>
+
+![alt text](img/image-7.png)
+
+<p>A tela com a listagem dos vinhos possui as seguintes características:</p>
+<ol>
+<li>Componente toolbar: agrupa os botões responsáveis por cadastrar um vinho novo, editar um dos vinhos listados na tela, excluir um dos vinhos ou avaliar um vinho.</li>
+<li>Componente multiselect: através desse componente é possível personalizar as colunas que serão exibidas na tela.</li>
+<li>Componente de pesquisa: a pesquisa pode ser feita por palavra chave e o sistema está apto a filtrar um vinho de acordo com o critério informado no campo. Não é necessário colocar uma palavra exata, a partir de uma letra o sistema inicia o filtro buscando em toda a tabela a resposta correspondente.</li>
+<li>Componente de exportação: os dados listados na tela podem ser exportados para um arquivo .csv permitindo ao usuário transportar essas informações para onde ele quiser.</li>
+<li>Componente de ordenação: é possível ordenar os registros de acordo com cada coluna da tabela, tanto em ordem ascendente quanto descendente.</li>
+<li>Componente checkbox: permite selecionar um registro ou mais registros. Necessário para editar ou excluir um ou mais vinhos.</li>
+</ol>
+
+![alt text](img/image-8.png)
+
+<p>A avaliação do vinho é feita a partir da seleção de um vinho, clicando no botão "Avaliar". O menu "Avaliações" lista todas as avaliações registradas no sistema.</p>
+
+![alt text](img/image-9.png)
+
+### Menu Degustação
+<p>O menu degustação apresenta as fichas de degustação cadastradas pelo usuário. Diferentemente do submenu "Avaliação", a degustação é algo mais elaborado, seguindo regras, conduzindo o usuário à uma degustação mais profissional, preenchendo literalmente uma ficha de degustação de vinhos.</p>
+
+![alt text](img/image-10.png)
+
+### Menu Harmonização
+
+<p>O ponto alto da solução está no menu Harmonização. Ao abrir a tela é apresentado ao usuário um campo onde ele informa o nome de um vinho e pode escolher uma entre três opções: 
+<ol>
+<li>Informações sobre o vinho;</li>
+<li>Sugestão de harmonização;</li>
+<li>Sugestão de menu.</li>
+</ol>
+</p>
+
+<p>O serviço responsável pela execução dessa tela foi concebido para utilizar uma Inteligência Artificial (IA) Generativa, baseada no GPT da OpenAi. Ao informar o vinho, essa IA buscará as informações e fará as recomendações conforme solicitado pelo usuário.</p>
+
+![alt text](img/image-11.png)
+
+<p>Para que isso seja possível é necessária a criação de uma APIKEY no site da <a href='https://platform.openai.com/api-keys' target="_blank">OpenAi</a>.</p>
+
+![alt text](img/image-12.png)
+
+### Instalando o Vinho Notas localmente
+
+<p>O fato do Vinho Notas ter sido construído como uma PWA permite que o usuário instale a solução em seu computador pessoal ou no celular. Para isso basta clicar no ícone que aparece no canto superior direito da barra de endereços do navagador:</p>
+
+![alt text](img/image-13.png)
+
+<p>O resultado final é uma aplicação limpa e visualmente agradável ao usuário:</p>
+
+![alt text](img/image-14.png)
+
+### Swagger
+<p>Após subir a aplicação você pode acessar o Swagger das APIs nos seguintes endereços:</p>
+<ul>
+<li>Cadastro: <a href='http://localhost:8080/swagger-ui/index.html' target="_blank">http://localhost:8080/swagger-ui/index.html</a></li>
+<li>Vinho: <a href='http://localhost:8081/swagger-ui/index.html' target="_blank">http://localhost:8081/swagger-ui/index.html</a></li>
+<li>Avaliação de Vinhos: <a href='http://localhost:8082/swagger-ui/index.html' target="_blank">http://localhost:8082/swagger-ui/index.html</a></li>
+<li>Degustação de Vinhos: <a href='http://localhost:8083/swagger-ui/index.html' target="_blank">http://localhost:8083/swagger-ui/index.html</a></li>
+<li>BFF: <a href='http://localhost:8084/swagger-ui/index.html' target="_blank">http://localhost:8084/swagger-ui/index.html</a></li>
+
+</ul>
+
+### Arquitetura do projeto
+
+O projeto é dividido em duas partes principais: o backend e o frontend. O backend é construído com Spring Boot e o frontend é construído com React + Vite.
+
+Em termos arquiteturais, o projeto segue o padrão MVC (Model-View-Controller) no backend e o padrão de componentes no frontend.
+
+![img_1.png](img/img_1.png)
+
+## Licença
+
+Este projeto está licenciado sob a licença MIT. Veja o arquivo `LICENSE` para mais detalhes.
+
+## Contato
+<p>Para contato utilize um dos canais abaixo:</p>
+<ul>
+<li><a href='https://www.linkedin.com/in/vanderlei-kleinschmidt-a1557731/' target="_blank">Linkedin</a></li>
+<li><a href='mailto:vanderleik@yahoo.com.br' target="_blank">vanderleik@yahoo.com.br</a></li>
+<li><a href='https://github.com/vanderleik' target="_blank">github.com/vanderleik</a></li>
+</ul>

avaliacao/Dockerfile

@@ -0,0 +1,30 @@
+# Usando uma imagem base com Java e Maven
+FROM maven:3.8.4-openjdk-17-slim AS build
+
+# Informações sobre o mantenedor
+LABEL maintainer="Vanderlei Kleinschmidt <vanderleik@yahoo.com.br>"
+
+# Copiando os arquivos do projeto
+COPY src /app/src
+
+# Copiando o arquivo pom.xml
+COPY pom.xml /app
+
+# Definindo o diretório de trabalho. É aqui que o Maven irá buildar o projeto
+WORKDIR /app
+
+# Baixe as dependências do Maven
+RUN mvn clean install
+
+FROM openjdk:17-jdk-slim
+
+# Copie o arquivo JAR do aplicativo
+COPY --from=build /app/target/avaliacao-1.0.0-alpha.jar /app/app.jar
+
+WORKDIR /app
+
+# Defina o endereço do banco de dados
+ENV DATABASE_URL jdbc:postgresql://postgresql-avaliacao:5432/vinho-notas-avaliacao
+
+EXPOSE 8082
+CMD ["java", "-jar", "app.jar"]

avaliacao/README.md

@@ -0,0 +1,44 @@
+# Serviço de Avaliação de Vinho
+
+Este é um serviço baseado em Java para gerenciar o micro serviço de avaliação de vinho. Ele usa PostgreSQL para armazenamento de dados e Maven para gerenciamento de projetos.
+
+## Estrutura do Projeto
+
+O projeto é estruturado em vários pacotes:
+- `com.vinhonotas.avaliacao.domain`: Contém as regras de negócio.
+- `com.vinhonotas.avaliacao.application`: Contém classes de serviços para as regras de negócio.
+- `com.vinhonotas.avaliacao.interfaces`: Contém classes de controle para manipulação de solicitações HTTP.
+- `com.vinhonotas.avaliacao.infrastructure`: Contém classes de repositório para acesso a dados.-
+- `com.vinhonotas.avaliacao.configuration`: Contém classes de configuração.
+- `com.vinhonotas.avaliacao.utils`: Contém classes utilitárias.
+
+## Configuração
+
+Para configurar o projeto, você precisa ter o Java e o Maven instalados. Em seguida, você pode clonar o repositório e executar `mvn install` para instalar as dependências necessárias.
+
+## Uso
+
+Você pode iniciar o aplicativo executando `mvn spring-boot:run`. O serviço estará disponível em `http://localhost:8082/swagger-ui/index.html`.
+
+## Endpoints
+
+### Point Scales: Operações relacionadas a avaliação de vinhos
+
+GET
+- `/api/v1/point-scales/{id}`: Retorna uma avaliação de vinho pelo id.
+
+PUT
+- `/api/v1/point-scales/{id}`: Atualiza uma avaliação de vinho pelo id.
+
+DELETE
+- `/api/v1/point-scales/{id}`: Deleta uma avaliação de vinho pelo id.
+
+GET
+- `/api/v1/point-scales`: Retorna todas as avaliações de vinho.
+
+POST
+- `/api/v1/point-scales`: Cria uma avaliação de vinho.
+
+## Licença
+
+Este projeto está licenciado sob a Licença MIT - veja o arquivo `LICENSE.md` para detalhes

avaliacao/pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>com.vinho-notas</groupId>
 	<artifactId>avaliacao</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
+	<version>1.0.0-alpha</version>
 	<name>avaliacao</name>
 	<description>avaliacao</description>
 	<properties>
@@ -102,6 +102,39 @@
 					</excludes>
 				</configuration>
 			</plugin>
+			<plugin>
+				<groupId>org.jacoco</groupId>
+				<artifactId>jacoco-maven-plugin</artifactId>
+				<executions>
+					<execution>
+						<goals>
+							<goal>prepare-agent</goal>
+						</goals>
+					</execution>
+					<execution>
+						<id>prepare-agent</id>
+						<goals>
+							<goal>prepare-agent</goal>
+						</goals>
+					</execution>
+					<execution>
+						<id>report</id>
+						<goals>
+							<goal>report</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<excludes>
+						<exclude>**/com/vinhonotas/avaliacao/AvaliacaoApplication.class</exclude>
+						<exclude>**/com/vinhonotas/avaliacao/domain/**</exclude>
+						<exclude>**/com/vinhonotas/avaliacao/interfaces/dtos/**</exclude>
+						<exclude>**/com/vinhonotas/avaliacao/utils/**</exclude>
+						<exclude>**/com/vinhonotas/avaliacao/configuration/**</exclude>
+						<exclude>**/com/vinhonotas/avaliacao/application/converters/**</exclude>
+					</excludes>
+				</configuration>
+			</plugin>
 		</plugins>
 	</build>