... | ... | @@ -96,12 +96,11 @@ Esta seção apresentará todas as configurações para executar o projeto. |
|
|
## Sumário
|
|
|
|
|
|
- [Configurações Gerais](#configurações-gerais)
|
|
|
- [Instalando o Node](#instalando-o-node)
|
|
|
- [Instalando o Java](#instalando-o-java)
|
|
|
- [Instalando o Docker](#instalando-o-docker)
|
|
|
- [Configurando sua IDE](#configurando-a-ide)
|
|
|
- [Clonando os Repositórios](#clonando-os-repositórios)
|
|
|
- [Backend](#backend)
|
|
|
- [Configurando a Máquina](#configurando-a-máquina)
|
|
|
- [Compilando](#compilando)
|
|
|
- [Executando](#executando)
|
|
|
- [Frontend](#frontend)
|
|
|
- [Configurando a Máquina](#configurando-a-máquina-1)
|
... | ... | @@ -161,16 +160,20 @@ O projeto FICAI 4.0 utiliza a versão 17 LTS do Java e, nas proximas seções, s |
|
|
|
|
|
### Instalando o Docker
|
|
|
|
|
|
#### Windows
|
|
|
O desenvolvimento do projeto FICAI 4.0 demanda um container do PostgreSQL. Para isso, precisamos instalar o Docker.
|
|
|
|
|
|
Para instalar o Docker no Windows, precisamos instalar o WSL (Windows Subsystem for Linux) antes. Para isso, siga em ordem os tutoriais oficiais de cada tecnologia:
|
|
|
#### Linux
|
|
|
|
|
|
1. [Instalação do WSL](https://docs.microsoft.com/en-us/windows/wsl/install)
|
|
|
1. [Instalação do Docker](https://docs.docker.com/desktop/install/windows-install/#install-docker-desktop-on-windows)
|
|
|
Para instalar o Docker no Linux, siga a documentação oficial do Docker, selecionando sua distribuição:
|
|
|
|
|
|
- [Instalação do Docker no Linux](https://docs.docker.com/desktop/install/linux-install/#generic-installation-steps)
|
|
|
|
|
|
#### Windows
|
|
|
|
|
|
#### Linux
|
|
|
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](https://docs.microsoft.com/en-us/windows/wsl/install)
|
|
|
1. [Instalação do Docker](https://docs.docker.com/desktop/install/windows-install/#install-docker-desktop-on-windows)
|
|
|
|
|
|
#### Verificação
|
|
|
|
... | ... | @@ -178,25 +181,58 @@ TBD |
|
|
|
|
|
### Configurando a IDE
|
|
|
|
|
|
TBD
|
|
|
Para o desenvolvimento do projeto FICAI 4.0, recomendamos o uso do editor de texto [Visual Studio Code](https://code.visualstudio.com/) 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
|
|
|
|
|
|
TBD
|
|
|
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:
|
|
|
|
|
|
```sh
|
|
|
git clone https://tools.ages.pucrs.br/ficai-4.0/ficai-4.0-backend.git
|
|
|
```
|
|
|
|
|
|
- [Backend](https://tools.ages.pucrs.br/ficai-4.0/ficai-4.0-backend)
|
|
|
- [Frontend]()
|
|
|
|
|
|
## Backend
|
|
|
|
|
|
### Configurando a Máquina
|
|
|
### Executando
|
|
|
|
|
|
TBD
|
|
|
Os proximos passos partem do ponto de que você já clonou o projeto conforme a seção [Clonando os Repositórios](#clonando-os-repositórios).
|
|
|
|
|
|
### Compilando
|
|
|
#### Passo 1: Rodando o Docker Compose
|
|
|
|
|
|
TBD
|
|
|
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:
|
|
|
|
|
|
### Executando
|
|
|
```sh
|
|
|
docker-compose up
|
|
|
```
|
|
|
|
|
|
TBD
|
|
|
#### 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:
|
|
|
|
|
|
```sh
|
|
|
./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
|
|
|
|
... | ... | |