Felipe Zômer da SilveiraDescrição
Esta seção apresentará todas as configurações para executar o projeto.
Sumário
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
- Antes de instalar o Java, certifique-se de seus pacotes estão atualizados com os comandos abaixo:
apt-get update
apt-get upgrade- Rode o comando abaixo para instalar a versão 17 da JDK do Java:
apt install openjdk-17-jdk openjdk-17-jre- Verifique se a instalação foi concluida com exito rodando o comando abaixo:
java --versionCaso retorne a versão do Java instalada, significa que a instalação foi bem sucedida.
Windows
-
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: -
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- Abra um novo PowerShell e rode o comando:
java --versionAo 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:
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:
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.gitBackend
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 upPasso 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:runPasso 2: Rodando a aplicação em ambiente local (Para Mac)
chmod u+x ./mvnw spring-boot:runou:
sudo chmod -R 777 /var/DirectoryNameO servidor estará rodando no seguinte link:
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:
Frontend
Configurando a Máquina
Para configurar o ambiente do projeto, siga esses passos:
- Faça o download do Node.js Baixe a versão
16.17.0; - Caso tenha outra versão do Node.js instalada, utilize o NVM para administrar versões, tutorial para configurar no Windows aqui;
- No terminal, utilize o comando:
$ # instalando versão do Angular CLI
$ npm install -g @angular/[email protected]- Para verificar que está tudo certo, faça:
$ # mostra versão do Angular CLI
$ ng versionOs dados informados devem ser:
Angular CLI: 14.1.3
Node: 16.17.0
Package Manager: npm 8.15.0
OS: win32 x64
Angular: 14.1.3
... animations, cli, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, router
Package Version
---------------------------------------------------------
@angular-devkit/architect 0.1401.3
@angular-devkit/build-angular 14.1.3
@angular-devkit/core 14.1.3
@angular-devkit/schematics 14.1.3
@schematics/angular 14.1.3
rxjs 7.5.6
typescript 4.7.4VS Code
Instale o VSCode, editor de código, se você ainda não tiver instalado. Após, instale os plugins:
- Angular Language Service;
- ESLint;
- Auto-import;
- Material Icon;
- Rainbow Brackets;
- px to Rem;
Caso tenha dúvidas em quais plugins baixar, consulte a primeria vídeo aula do bootcamp fornecida pelo colega Eduardo Soares, no canal de #estudos
(Estes plugins não são obrigatórios, mas te ajudarão a manter um código padronizado).
Executando
- Abra o terminal do seu computador ou git bash e digite um comando por vez:
$ # dentro da pasta que você deseja clonar o projeto
$ cd C:\Users\exemplo\diretorio
$ # clonando o repositório do projeto:
$ git clone https://tools.ages.pucrs.br/ficai-4.0/ficai-4.0-frontend.git
$ # entrando no diretório do app
$ cd ficai-4.0-frontend
$ # instalando as dependências
$ npm install
$ # iniciando o projeto
$ npm startSe todos o passos foram concluídos corretamente, ao rodar o comando npm start ou acessar o link http://localhost:4200/ deve direcioná-lo à pagina home do projeto.