configuracao

Home	Gerência	Processo	Design/Mockups	Configuração	Arquitetura	Código	Banco de Dados	Utilização

Configurações do Projeto

Descrição

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

Sumário

Configurações Gerais
- Instalando o Node
- Configurando sua IDE
Backend
Frontend
- Tecnologias
- Configurando a Máquina

Configurações Gerais

Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.

Instalando o Node

Instalação

Para instalar o Node, basta escolher a versão compatível com seu sistema operacional e seguir os passos da configuração.

Configurando a IDE

Baixe o Visual Studio Code e, para auxiliar no desenvolvimento do projeto, instale as seguintes extensões na sua máquina:

Backend

Tecnologias do Backend

Node.js / Express.js

Postgres

Configurando a Máquina para ambiente Backend

No repositório do backend do projeto, podemos ver no README as informações referentes a configuração da máquina, compiliação e execução.

Realizando requisições com Postman

Uma vez que o backend da aplicação está configurado e sendo executado, recomenda-se o uso da plataforma Postman como cliente HTTP para realizar as requisições para a API a partir de uma interface gráfica. O Postman, que pode ser instalado neste link, é a ferramenta utilizada para gerar a documentação da API do Autis, que a equipe escolheu por ser fácil de utilizar.

Esta documentação está publicada e pode ser acessada aqui: https://documenter.getpostman.com/view/12268975/UVyyrsC6

Esta documentação está organizada em uma collection do Postman, que é basicamente um diretório onde você pode organizar as suas requisições e outros elementos de sua API, como variáveis ou testes. Nesta collection as requisições estão organizadas em diretórios de acordo com a entidade a qual são relacionadas (ex.: Material ou Usuário), e em cada pasta estão as requisições possíveis que podem ser feitas para cada caso, como visto na imagem abaixo:

Assim, existe na documentação uma requisição para cada endpoint da API que foi implementado, e a partir dos dados de exemplo já preenchidos nessa requisição, é possível fazer alterações para construir a requisição desejada. Na imagem abaixo está um exemplo de requisição para criar um professor 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, a resposta é apresentada na tela, como ilustrado na figura abaixo. Ao clicar na opção Save response, você pode salvar a resposta retornada como exemplo, e por isso sugere-se sempre salvar um exemplo de resposta de sucesso e de erro, para que se entenda o formato da resposta da API em cada situação ao ler a documentação.

Para que o time possa realizar as requisições para a API usando esta collection, ela deve ser exportada como um arquivo JSON após cada alteração na documentação e ser commitada no repositório de backend, estando disponível aqui: https://tools.ages.pucrs.br/autis/autis-backend/-/blob/dev/AUTIS-Backend.postman_collection.json

⚠ Para manter essa collection atualizada, sugere-se que a cada novo endpoint ou correção importante, esta documentação seja atualizada e commitada novamente junto ao merge request da tarefa.

Para realizar as requisições para a API a partir deste arquivo, siga os passos abaixo: