|
|
|
# Configurações do Projeto
|
|
|
|
|
|
|
|
Esta página descreve todas as configurações a serem feitas na sua máquina para execução do projeto.
|
|
|
|
|
|
|
|
## Sumário
|
|
|
|
|
|
|
|
- [Configurações Gerais](#configurações-gerais)
|
|
|
|
- [Instalando o Git](#instalando-o-git)
|
|
|
|
- [Instalando o Docker](#instalando-o-docker)
|
|
|
|
- [Realizando o clone do projeto do GitLab](#realizando-o-clone-do-projeto-do-gitlab)
|
|
|
|
- [Backend](#backend)
|
|
|
|
- [Tecnologias](#tecnologias-do-backend)
|
|
|
|
- [Configurando a Máquina](#configurando-a-máquina-para-ambiente-backend)
|
|
|
|
- [Instalando a ferramenta de gerenciamento de banco de dados](#instalando-a-ferramenta-de-gerenciamento-de-banco-de-dados)
|
|
|
|
- [Configurando o Postman](#configurando-o-postman)
|
|
|
|
- [Frontend](#frontend)
|
|
|
|
- [Tecnologias](#tecnologias-do-frontend)
|
|
|
|
- [Configurando a Máquina](#configurando-a-máquina-para-ambiente-frontend)
|
|
|
|
|
|
|
|
## Configurações Gerais
|
|
|
|
|
|
|
|
Esta seção descreve as configurações a serem feitas em ambos ambientes de desenvolvimento, tanto no de Frontend quanto no de Backend.
|
|
|
|
|
|
|
|
### 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 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.
|
|
|
|
|
|
|
|
### 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 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 Windows: https://docs.docker.com/desktop/install/windows-install/
|
|
|
|
|
|
|
|
Nos sistemas operacionais Windows e Mac, é preciso instalar o Docker Desktop, que cria uma máquina virtual para execução dos containes, enquanto no Linux basta a instalação do Docker Engine e não é obrigatória a instalação do Docker Desktop. No entanto, recomenda-se a instalação do Docker Desktop em todos os ambientes, pois é instalado junto uma interface gráfica e outras funcionalidades que serão utilizadas no projeto, a exemplo do Docker Compose.
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
- [Backend](https://tools.ages.pucrs.br/sem-barreiras/sembarreiras-backend)
|
|
|
|
- [Frontend](https://tools.ages.pucrs.br/sem-barreiras/sembarreiras-frontend)
|
|
|
|
- [Wiki](https://tools.ages.pucrs.br/sem-barreiras/wiki)
|
|
|
|
|
|
|
|
Em seguida, clique no botão "Clone" da página do repositório selecionado, e selecione uma das duas opções de clone: via SSH ou via HTTPS.
|
|
|
|
|
|
|
|
- Se for selecionada a opção clonar com SSH, você precisa criar chaves SSH e adicionar elas em seu perfil do GitLab para se autenticar com elas no GitLab. Para mais informações, ler [esta documentação](https://docs.gitlab.com/ee/user/ssh.html)
|
|
|
|
- Se for selecionada a opção clonar com HTTPS, você precisa se autenticar no GitLab usando seu usuário e senha. Sugere-se esta opção, por ser mais fácil de configurar.
|
|
|
|
|
|
|
|
Por fim, copie o link da alternativa selecionada e digite o comando abaixo, no terminal de linha de comando da sua máquina no diretório em que você deseja criar a cópia:
|
|
|
|
|
|
|
|
```shell
|
|
|
|
git clone "link copiado aqui"
|
|
|
|
```
|
|
|
|
|
|
|
|
## Backend
|
|
|
|
|
|
|
|
Esta seção descreve as configurações a serem feitas para o ambiente de desenvolvimento Backend.
|
|
|
|
|
|
|
|
### Tecnologias do Backend
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
### Configurando a Máquina para ambiente Backend
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
### Instalando a ferramenta de gerenciamento de banco de dados
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
### Configurando o Postman
|
|
|
|
|
|
|
|
Realizada a configuração do ambiente Backend do projeto, utilizaremos a plataforma Postman como cliente HTTP para realizar as requisições para a API a partir de uma interface gráfica. Além disso, será a ferramenta utilizada para gerar a documentação da API do projeto.
|
|
|
|
|
|
|
|
O Postman pode ser instalado [neste link](https://www.postman.com/downloads/).
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
## Frontend
|
|
|
|
|
|
|
|
Esta seção descreve as configurações a serem feitas para o ambiente de desenvolvimento Frontend.
|
|
|
|
|
|
|
|
### Tecnologias do Frontend
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
### Configurando a Máquina para ambiente Frontend
|
|
|
|
|
|
|
|
TODO |
