Configurações do Projeto

Descrição

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

Sumário

• Configurações Gerais
  • Configurando sua IDE
  • Clonando os Repositórios
• Backend
  • Configurando a Máquina
  • Compilando e 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.

Configurando a IDE

Para o Backend

A IDE recomendada para se trabalhar no backend é o IntelliJ, pois atende todas as necessidades do projeto de forma prática.

Link para instalação do IntelliJ: https://www.jetbrains.com/pt-br/idea/download

Para o Frontend

TBD

Clonando os Repositórios

Para o Backend

Para clonar o repositório do backend em seu computador basta executar um dos comandos abaixo:

Via HTTP:

git clone http://tools.ages.pucrs.br/comunicacao-hsl/backend.git

Via SSH:

git clone ssh://[email protected]:8822/comunicacao-hsl/backend.git

Para o Frontend

Para clonar o repositório do frontend em seu computador basta executar um dos comandos abaixo:

Via HTTP:

git clone http://tools.ages.pucrs.br/comunicacao-hsl/frontend.git

Via SSH:

git clone ssh://[email protected]:8822/comunicacao-hsl/frontend.git

Backend

Configurando a Máquina

• Java:

  Instalar a JDK, de preferência a 11.

  Link para instalação do AdoptOpenJDK 11: https://adoptium.net/releases.html?variant=openjdk11

• Gradle:

  Instalar a versão 6.9.x do Gradle.

  Link para instalação: https://gradle.org/install/

• WSL:

  Instalar a versão última versão do WSL.

  Link para instalação: https://docs.microsoft.com/pt-br/windows/wsl/install

• Docker:

  Instalar a última versão do Docker. Seguir os passos abaixo para instalar o docker em seu sistema operacional.

  Link para instalação: https://docs.docker.com/get-docker/

• IntelliJ:

  Instalar a última versão do IntelliJ.

  Link para instalação do IntelliJ: https://www.jetbrains.com/pt-br/idea/download

  Após clonar o projeto e instalar todos os requisitos, abra o projeto com o IntelliJ e aguarde a instalação de todas as dependências gradle. Caso a IDE peça para instalar o SDK recomendado, aceite a instalação.

Compilando e Executando

Após ter tudo instalado e rodando, é só utilizar o comando abaixo para subir o backend e o banco de dados:

gradle bootJar && docker build -t app . && docker image prune -f --all && docker-compose up

O comando faz os seguintes passos:

• Compila o código e empacota em um .jar
• Gera uma imagem do docker
• Remove as imagens que não estão sendo utilizadas
• Sobe os containeres de backend e banco de dados.

Frontend

Configurando a Máquina

Instale o Android Studio através do Jetbrains Toolbox. Esse passo é necessário, pois o Android Studio facilita a instalação do Android SDK e o Jetbrains Toolbox auxilia na instalação do Flutter.

A página de instalação do Flutter contém instruções simples e fáceis de seguir. Depois de feito o download, execute o comando flutter doctor. É possível que ele não tenha encontrado o caminho para o Android Studio.

Para resolver isso, vais ao JetBrains Toolbox, abra as configurações do Android Studio e na opção de configuração, em local de instalação, vai indicar onde ele está instalado, copie isso e no seguinte comando:

flutter config --android-studio-dir <directory>

Substitua o <directory> pelo o que foi copiado.

Não esqueça de executar este comando flutter doctor --android-licenses.

Compilando

TBD

Executando

TBD