... | @@ -26,15 +26,15 @@ Esta seção descreve as configurações a serem feitas em ambos ambientes de de |
... | @@ -26,15 +26,15 @@ Esta seção descreve as configurações a serem feitas em ambos ambientes de de |
|
|
|
|
|
### Instalando o Git
|
|
### Instalando o Git
|
|
|
|
|
|
Para versionamento dos arquivos do projeto, utilizamos o sistema de controle de versão Git. Com o Git, todas as alterações realizadas no projeto, sejam estas novas funcionalidades ou correções, são registradas no histórico dos repositórios do projeto.
|
|
Para versionamento dos arquivos do projeto, utilizamos o sistema de controle de versão **Git**. Com o Git, todas as alterações realizadas no projeto, sejam estas novas funcionalidades ou correções, são registradas no histórico dos repositórios do projeto.
|
|
|
|
|
|
Para instalar o Git, selecione o seu sistema operacional [nesta página de Downloads](https://git-scm.com/downloads) e siga as instruções do site.
|
|
Para instalar o Git, selecione o seu sistema operacional [nesta página de Downloads](https://git-scm.com/downloads) e siga as instruções do site.
|
|
|
|
|
|
Além disso, recomenda-se o uso da ferramenta Git Kraken para conseguir visualizar as branches de repositórios Git e executar comandos Git por meio de uma interface gráfica, ao invés de via linha de comando. Esta ferramenta pode ser instalada [aqui](https://www.gitkraken.com/download).
|
|
Além disso, recomenda-se o uso da ferramenta **Git Kraken** para conseguir visualizar as branches de repositórios Git e executar comandos Git por meio de uma interface gráfica, ao invés de via linha de comando. Esta ferramenta pode ser instalada [aqui](https://www.gitkraken.com/download).
|
|
|
|
|
|
### Instalando o Docker
|
|
### Instalando o Docker
|
|
|
|
|
|
Para executarmos as aplicações local e na AWS, elas executarão dentro do ambiente isolado de containers. Para isso, será utilizada durante o projeto a ferramenta Docker, que pode ser instalada a partir das documentações abaixo:
|
|
Para executarmos as aplicações local e na AWS, elas executarão dentro do ambiente isolado de containers. Para isso, será utilizada durante o projeto a ferramenta **Docker**, que pode ser instalada a partir das documentações abaixo:
|
|
|
|
|
|
- Para usuários de Linux: https://docs.docker.com/desktop/install/linux-install/
|
|
- Para usuários de Linux: https://docs.docker.com/desktop/install/linux-install/
|
|
- Para usuários de Mac: https://docs.docker.com/desktop/install/mac-install/
|
|
- Para usuários de Mac: https://docs.docker.com/desktop/install/mac-install/
|
... | @@ -44,7 +44,7 @@ Nos sistemas operacionais Windows e Mac, é preciso instalar o Docker Desktop, q |
... | @@ -44,7 +44,7 @@ Nos sistemas operacionais Windows e Mac, é preciso instalar o Docker Desktop, q |
|
|
|
|
|
### Realizando o clone do projeto do GitLab
|
|
### Realizando o clone do projeto do GitLab
|
|
|
|
|
|
Os repositórios do projeto Sem Barreiras estão hospedados de forma remota no GitLab, de modo que, para realizar e salvar alterações nestes repositórios na sua máquina local, é preciso clonar estes repositórios na sua máquina. Ao clonar um repositório, você está criando uma cópia local dele na sua máquina, na qual você pode trabalhar de forma independente e, ao concluir as suas alterações, enviar elas para o repositório remoto.
|
|
Os repositórios do projeto Sem Barreiras estão hospedados de forma remota no **GitLab**, de modo que, para realizar e salvar alterações nestes repositórios na sua máquina local, é preciso clonar estes repositórios na sua máquina. Ao clonar um repositório, você está criando uma cópia local dele na sua máquina, na qual você pode trabalhar de forma independente e, ao concluir as suas alterações, enviar elas para o repositório remoto.
|
|
|
|
|
|
Para fazer o clone dos projetos vá até a [página do GitLab do grupo Sem Barreiras](https://tools.ages.pucrs.br/sem-barreiras), onde você pode selecionar qual repositório deseja clonar:
|
|
Para fazer o clone dos projetos vá até a [página do GitLab do grupo Sem Barreiras](https://tools.ages.pucrs.br/sem-barreiras), onde você pode selecionar qual repositório deseja clonar:
|
|
|
|
|
... | @@ -88,15 +88,21 @@ Se ao lado de "java version" for exibido uma versão que inicia com "11.", entã |
... | @@ -88,15 +88,21 @@ Se ao lado de "java version" for exibido uma versão que inicia com "11.", entã |
|
|
|
|
|
Para desenvolvimento no repositório de Backend do projeto, sugere-se o uso da ferramenta [IntelliJ IDEA](https://www.jetbrains.com/pt-br/idea/download/?section=windows), seja a edição Community ou seja a edição Ultimate. A edição Ultimate, no entanto, é mais completa e possui mais funcionalidades para se trabalhar com projetos Spring, por isso se sugere baixar esta versão. Além disso, ainda que a versão Ultimate seja paga, é possível conseguir uma licença para estudantes ao se cadastrar com o e-mail da PUCRS seguindo os passos descritos [aqui](https://www.jetbrains.com/community/education/#students).
|
|
Para desenvolvimento no repositório de Backend do projeto, sugere-se o uso da ferramenta [IntelliJ IDEA](https://www.jetbrains.com/pt-br/idea/download/?section=windows), seja a edição Community ou seja a edição Ultimate. A edição Ultimate, no entanto, é mais completa e possui mais funcionalidades para se trabalhar com projetos Spring, por isso se sugere baixar esta versão. Além disso, ainda que a versão Ultimate seja paga, é possível conseguir uma licença para estudantes ao se cadastrar com o e-mail da PUCRS seguindo os passos descritos [aqui](https://www.jetbrains.com/community/education/#students).
|
|
|
|
|
|
|
|
Após clonar o repositório do GitLab do Backend, abra a pasta onde o repositório foi clonado no IntelliJ, conforme imagem abaixo:
|
|
|
|
|
|
|
|
<img src="./resources/images/intellij-criar-projeto.png" width="400">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Instalando a ferramenta de gerenciamento de banco de dados
|
|
### Instalando a ferramenta de gerenciamento de banco de dados
|
|
|
|
|
|
Como será utilizado o PostgreSQL como banco de dados relacional do projeto, recomenda-se a instalação da ferramenta DBeaver, que permite que você se conecte a diferentes bancos de dados relacionais, incluindo o PostgreSQL, e que você manipule os dados persistidos no banco.
|
|
Como será utilizado o **PostgreSQL** como banco de dados relacional do projeto, recomenda-se a instalação da ferramenta **DBeaver**, que permite que você se conecte a diferentes bancos de dados relacionais, incluindo o PostgreSQL, e que você manipule os dados persistidos no banco.
|
|
|
|
|
|
Para instalar o DBeaver, siga as instruções presentes no [site da ferramenta](https://dbeaver.io/download/).
|
|
Para instalar o DBeaver, siga as instruções presentes no [site da ferramenta](https://dbeaver.io/download/).
|
|
|
|
|
|
### Configurando o Postman
|
|
### Configurando o Postman
|
|
|
|
|
|
Realizada a configuração do ambiente Backend do projeto, é possível utilizar a plataforma Postman como cliente HTTP para realizar as requisições para a API a partir de uma interface gráfica. Para isso e para documentar a API, no entanto, também pode-se utilizar o Swagger, que está configurado para o projeto de Backend, então só é preciso instalar o Postman caso você prefira trabalhar com esta ferramenta.
|
|
Realizada a configuração do ambiente Backend do projeto, é possível utilizar a plataforma **Postman** como cliente HTTP para realizar as requisições para a API a partir de uma interface gráfica. Para isso e para documentar a API, no entanto, também pode-se utilizar o Swagger, que está configurado para o projeto de Backend, então só é preciso instalar o Postman caso você prefira trabalhar com esta ferramenta.
|
|
|
|
|
|
O Postman pode ser instalado [neste link](https://www.postman.com/downloads/).
|
|
O Postman pode ser instalado [neste link](https://www.postman.com/downloads/).
|
|
|
|
|
... | | ... | |