| ... | ... | @@ -58,7 +58,7 @@ Nos sistemas operacionais Windows e Mac, é preciso instalar o Docker Desktop, q |
|
|
|
|
|
|
|
Os repositórios do projeto Lucky Draw 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 Lucky Draw](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 Lucky Draw](https://tools.ages.pucrs.br/lucky-draw), onde você pode selecionar qual repositório deseja clonar:
|
|
|
|
|
|
|
|
* [Backend](https://tools.ages.pucrs.br/lucky-draw/back-end)
|
|
|
|
* [Frontend](https://tools.ages.pucrs.br/lucky-draw/front-end)
|
| ... | ... | @@ -72,4 +72,75 @@ Por fim, copie o link da alternativa selecionada e digite o comando abaixo, no t |
|
|
|
|
|
|
|
```shell
|
|
|
|
git clone "link copiado aqui"
|
|
|
|
``` |
|
|
\ No newline at end of file |
|
|
|
```
|
|
|
|
|
|
|
|
## Backend
|
|
|
|
|
|
|
|
Esta seção descreve as configurações a serem feitas para o ambiente de desenvolvimento Backend.
|
|
|
|
|
|
|
|
### Tecnologias do Backend
|
|
|
|
|
|
|
|
* Java 17
|
|
|
|
* Spring Boot 3.4.3
|
|
|
|
* Maven 4.0.0
|
|
|
|
* Docker
|
|
|
|
* Docker Compose
|
|
|
|
* PostgreSQL 15.6
|
|
|
|
|
|
|
|
Para instalar o Java 17 na sua máquina, realize o *download* de um dos instaladores presentes [neste site da Oracle](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html).
|
|
|
|
|
|
|
|
Caso você já possua o Java instalado em sua máquina, mas não tem certeza se é a versão correta, execute o comando abaixo via terminal.
|
|
|
|
|
|
|
|
```shell
|
|
|
|
java -version
|
|
|
|
```
|
|
|
|
|
|
|
|
Se ao lado de "java version" for exibido uma versão que inicia com "17.", então não é necessário instalar uma nova versão em sua máquina.
|
|
|
|
|
|
|
|
### Configurando a IDE para ambiente Backend
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
Mais detalhes sobre como executar o projeto em sua máquina podem ser lidos no [README](https://tools.ages.pucrs.br/lucky-draw/wiki/-/wikis/backend/-/blob/main/README.md) do repositório Backend do projeto.
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
Para instalar o DBeaver, siga as instruções presentes no [site da ferramenta](https://dbeaver.io/download/).
|
|
|
|
|
|
|
|
Uma vez instalado o DBeaver, para se conectar com o banco de dados utilizado pela aplicação, siga os passos abaixo:
|
|
|
|
|
|
|
|
1. Clique no botão para criar uma nova conexão com um banco de dados
|
|
|
|
|
|
|
|
|
|
|
|
2. Selecione a opção PostgreSQL e clique em "Next"
|
|
|
|
|
|
|
|
|
|
|
|
3. Configure a conexão com o banco de dados, preenchendo o host, o nome do banco de dados, o usuário e a senha conforme configurações presentes no [repositório Backend do projeto](https://tools.ages.pucrs.br/sem-barreiras/sembarreiras-backend).
|
|
|
|
4. Teste a conexão clicando no botão "Test Connection"
|
|
|
|
5. Se no teste a conexão for realizada com sucesso, clique em "Finish" para se conectar ao banco de dados. Ao finalizar, você deve conseguir visualizar os dados da sua conexão na lateral esquerda da interface, onde você pode: visualizar as tabelas presentes no banco de dados e as suas colunas; criar e executar scripts SQL; entre outros.
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
O Postman pode ser instalado [neste link](https://www.postman.com/downloads/).
|
|
|
|
|
|
|
|
Após a instalação da ferramenta, as requisições a serem realizadas pelo Postman para a API deverão ser organizadas em uma collection. Uma collection é basicamente um agrupamento de requisições que permite que as requisições de sua API sejam organizadas em diretórios, exportadas e compartilhadas com os colegas de equipe. Na collection da API do projeto Sem Barreiras, as requisições devem ser agrupadas em diretórios de acordo com a entidade a qual estão relacionadas, e em cada pasta devem existir as requisições possíveis que podem ser feitas em cada caso. Para exemplificar, segue a imagem abaixo de uma API fictícia:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Assim, vai existir na documentação da API uma requisição para cada endpoint que foi implementado, e, a partir dos dados de exemplo já preenchidos, será possível fazer alterações para construir a requisição desejada e executar as chamadas HTTP. Na imagem abaixo existe um exemplo de requisição desta mesma API fictícia, para criar um livro no banco de dados, e as setas destacam algumas das informações que podem ser alteradas para personalizar a requisição (e.g.: path parameters na URL ou corpo da requisição).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Uma vez que a requisição é enviada, os dados da resposta (status, corpo, headers, tempo de resposta, etc) são apresentados na tela, como ilustrado na figura. Durante a criação de novas rotas, busque também clicar na opção "Save as example" para salvar a resposta retornada como exemplo. Ao salvar exemplos de resposta de sucesso e de erro na collection, a documentação da API ficará mais completa e será possível entender o formato de resposta da API em cada situação.
|
|
|
|
|
|
|
|
Além disso, toda vez que for feita uma alteração na collection, ela deve ser exportada como um arquivo JSON e em seguida commitada no repositório do Backend do projeto, para que todos os integrantes da equipe tenham acesso à documentação atualizada.
|
|
|
|
|
|
|
|
## Frontend
|
|
|
|
|
|
|
|
Esta seção descreve as configurações a serem feitas para o ambiente de desenvolvimento Frontend. |
|
|
\ No newline at end of file |
