GitLab

Descrição

Esta seção apresentará todas as configurações para executar o projeto.

Sumário

• Configurações Gerais
  • Instalando o Java
  • Instalando o Docker
  • Configurando sua IDE
  • Clonando os Repositórios
• Backend
  • Executando
• Frontend
  • Configurando a Máquina
  • Compilando
  • Executando

Configurações Gerais

Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.

Instalando o Java

O projeto FICAI 4.0 utiliza a versão 17 LTS do Java e, nas proximas seções, será ensinado como instalar a JDK para Windows, Linux e Mac.

Linux

1. Antes de instalar o Java, certifique-se de seus pacotes estão atualizados com os comandos abaixo:

apt-get update
apt-get upgrade

2. Rode o comando abaixo para instalar a versão 17 da JDK do Java:

apt install openjdk-17-jdk openjdk-17-jre

3. Verifique se a instalação foi concluida com exito rodando o comando abaixo:

java --version

Caso retorne a versão do Java instalada, significa que a instalação foi bem sucedida.

Windows

1. Primeiramente, efetue a instalação do gerenciador de pacotes Chocolatey através do link a seguir, seguindo a seção Install Chocolatey for Individual Use:

   • https://chocolatey.org/install

2. No mesmo PowerShell do passo anterior, após a instalação do Chocolatey, rode o comando abaixo para instalar a versão 17 do Java:

choco install openjdk17

3. Abra um novo PowerShell e rode o comando:

java --version

Ao retornar a versão do Java instalada significa que a instalação foi bem sucedida.

Mac

Baixe o dmg do Java JDK 17.0 no link: https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html

Caso você esteja acostumado com o gerenciador de pacotes brew, você pode utilizá-lo para as instalações.

Instalando o Docker

O desenvolvimento do projeto FICAI 4.0 demanda um container do PostgreSQL. Para isso, precisamos instalar o Docker.

Linux

Para instalar o Docker no Linux, siga a documentação oficial do Docker, selecionando sua distribuição:

• Instalação do Docker no Linux

Windows

Para instalar o Docker no Windows, precisamos instalar o WSL (Windows Subsystem for Linux) antes. Para isso, siga em ordem os tutoriais oficiais de instalação de cada tecnologia:

1. Instalação do WSL
2. Instalação do Docker

Mac

Se o seu Mac é Catalina, Big Sur, or Monterey, você pode baixar o Docker pelo link: https://docs.docker.com/desktop/install/mac-install/

Verificação

TBD

Configurando a IDE

Para o desenvolvimento do projeto FICAI 4.0, recomendamos o uso do editor de texto Visual Studio Code para o frontend e backend. Nas seções a seguir serão listados os plugins recomendados.

Backend

• Extension Pack for Java (Microsoft)
• Docker (Microsoft)
• PostgreSQL (Chris Kolkman)

Frontend

Clonando os Repositórios

Abaixo os links para os repositórios do backend e frontend. A partir deles, basta copiar o link clicando no botão Clone e escolher entre SSH ou HTTPS. Com o link copiado, rode o comando abaixo substituindo o link de exemplo pelo do repositório desejado:

git clone https://tools.ages.pucrs.br/ficai-4.0/ficai-4.0-backend.git

• Backend
• Frontend

Backend

Executando

Os proximos passos partem do ponto de que você já clonou o projeto conforme a seção Clonando os Repositórios.

Passo 1: Rodando o Docker Compose

Antes de rodar nossa API, precisamos subir o docker compose que contém o container do nosso banco de dados. Para isso, rode o comando abaixo dentro da raiz do projeto:

docker-compose up

Passo 2: Rodando a aplicação em ambiente local

Com o compose iniciado, estamos aptos a rodar a nossa aplicação localmente. Na raiz do projeto, rode o comando abaixo:

./mvnw spring-boot:run

O servidor estará rodando no seguinte link:

• http://localhost:8080/ficai

Passo 3: Acessando as rotas do projeto

Com o servidor ligado, você terá acesso a documentação das rotas do projeto, podendo interagir com elas pelo link abaixo:

• http://localhost:8080/ficai/swagger-ui.html

Frontend

Configurando a Máquina

TBD

Compilando

TBD

Executando

TBD