|
|[Home](home)|[Escopo](escopo)|[Processo](processo)|[Design](design)|[**Configuração**](configuracao)|[Arquitetura](arquitetura)|[Código](codigo)|[Banco de Dados](banco_dados)|[Qualidade](qualidade)|[Instalação](instalacao)|
|
|
| [Home](home) | [Escopo](escopo) | [Cronograma](cronograma) | [Design](design) | [**Configuração**](configuracao) | [Arquitetura](arquitetura) | [Código](codigo) | [Banco de Dados](banco_dados) | [Qualidade](qualidade) | [Instalação](instalacao) |
|
|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|
|
| :----------: | :--------------: | :----------------------: | :--------------: | :------------------------------: | :------------------------: | :--------------: | :---------------------------: | :--------------------: | :----------------------: |
|
|
|
|
|
|
|
|
|
|
# Configurações do Projeto
|
|
# Configurações do Projeto
|
|
|
|
|
|
## Descrição
|
|
## Descrição
|
|
|
|
|
|
Esta seção apresentará todas as configurações para executar o projeto.
|
|
Esta seção apresentará todas as configurações para executar o projeto.
|
|
|
|
|
|
## Sumário
|
|
## Sumário
|
|
|
|
|
|
- [Configurações Gerais](#configurações-gerais)
|
|
- [Configurações Gerais](#configurações-gerais)
|
|
- [Instalando o Node](#instalando-o-node)
|
|
- [Instalando o Node](#instalando-o-node)
|
|
- [Configurando sua IDE](#configurando-a-ide)
|
|
- [Configurando sua IDE](#configurando-a-ide)
|
... | @@ -20,8 +23,11 @@ Esta seção apresentará todas as configurações para executar o projeto. |
... | @@ -20,8 +23,11 @@ Esta seção apresentará todas as configurações para executar o projeto. |
|
- [Executando](#executando-1)
|
|
- [Executando](#executando-1)
|
|
|
|
|
|
## Configurações Gerais
|
|
## Configurações Gerais
|
|
|
|
|
|
Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.
|
|
Aqui serão encontradas as instruções de configuração de ambos ambientes de desenvolvimento.
|
|
|
|
|
|
### Instalando o Node
|
|
### Instalando o Node
|
|
|
|
|
|
#### Instalação
|
|
#### Instalação
|
|
|
|
|
|
O download do instalador do Node pode ser realizado pelo seguinte [link](https://nodejs.org/en/).
|
|
O download do instalador do Node pode ser realizado pelo seguinte [link](https://nodejs.org/en/).
|
... | @@ -45,13 +51,15 @@ Depois execute o seguinte comando `npm -v` e novamente verifique se o retorno é |
... | @@ -45,13 +51,15 @@ Depois execute o seguinte comando `npm -v` e novamente verifique se o retorno é |
|
C:\user\npm-v
|
|
C:\user\npm-v
|
|
v6.14.8
|
|
v6.14.8
|
|
```
|
|
```
|
|
|
|
|
|
### Configurando a IDE
|
|
### Configurando a IDE
|
|
|
|
|
|
Para o desenvolvimento do código e fácil controle de versionamento (GitLab) sugerimos a instalação do [Visual Studio Code](https://code.visualstudio.com/). O mesmo além de ser uma ótima ferramenta para desenvolvimento conta com extensões que serão essenciais para padronização do código do projeto.
|
|
Para o desenvolvimento do código e fácil controle de versionamento (GitLab) sugerimos a instalação do [Visual Studio Code](https://code.visualstudio.com/). O mesmo além de ser uma ótima ferramenta para desenvolvimento conta com extensões que serão essenciais para padronização do código do projeto.
|
|
|
|
|
|
Depois de instalar o Visual Studio Code, acesse sua aba de extensões e instale as seguintes:
|
|
Depois de instalar o Visual Studio Code, acesse sua aba de extensões e instale as seguintes:
|
|
|
|
|
|
* ESLint: Para que a IDE identifique padrões do React que estão sendo desrespeitados.
|
|
- ESLint: Para que a IDE identifique padrões do React que estão sendo desrespeitados.
|
|
* Prettier: Para que a IDE realize a indentação do código de maneira correta.
|
|
- Prettier: Para que a IDE realize a indentação do código de maneira correta.
|
|
|
|
|
|
Caso deseje também, baixe a extensão do Material (Material Theme) no seu VS Code para uma melhor apresentação visualmente da estrutura do projeto
|
|
Caso deseje também, baixe a extensão do Material (Material Theme) no seu VS Code para uma melhor apresentação visualmente da estrutura do projeto
|
|
|
|
|
... | @@ -67,6 +75,7 @@ Depois de adicionar as extensões necessárias, falta apenas uma configuração |
... | @@ -67,6 +75,7 @@ Depois de adicionar as extensões necessárias, falta apenas uma configuração |
|
> Caso o mesmo já esteja presente, desconsidere.
|
|
> Caso o mesmo já esteja presente, desconsidere.
|
|
|
|
|
|
### Clonando os Repositórios
|
|
### Clonando os Repositórios
|
|
|
|
|
|
Para ser necessário clonar o projeto, é preciso primeiro acessar a página do nosso time, disponível [aqui](https://tools.ages.pucrs.br/olive).
|
|
Para ser necessário clonar o projeto, é preciso primeiro acessar a página do nosso time, disponível [aqui](https://tools.ages.pucrs.br/olive).
|
|
|
|
|
|
Na página inicial do time, você irá encontrar todos os repositórios referentes à esse projeto:
|
|
Na página inicial do time, você irá encontrar todos os repositórios referentes à esse projeto:
|
... | @@ -85,15 +94,16 @@ Após selecionar o repositório que deseja clonar, irá aparecer um botão escri |
... | @@ -85,15 +94,16 @@ Após selecionar o repositório que deseja clonar, irá aparecer um botão escri |
|
|
|
|
|
> Com o link copiado, basta abrir um terminal (cmd no Windows) na pasta onde gostaria de deixar salvo o repositório em sua máquina e digitar o seguinte comando:
|
|
> Com o link copiado, basta abrir um terminal (cmd no Windows) na pasta onde gostaria de deixar salvo o repositório em sua máquina e digitar o seguinte comando:
|
|
|
|
|
|
* git clone "link do repositório"
|
|
- git clone "link do repositório"
|
|
|
|
|
|
> Não é necessário colocar as aspas, apenas o link
|
|
> Não é necessário colocar as aspas, apenas o link
|
|
|
|
|
|
Pronto, você agora possui uma instância local do repositório!
|
|
Pronto, você agora possui uma instância local do repositório!
|
|
|
|
|
|
|
|
|
|
## Backend
|
|
## Backend
|
|
|
|
|
|
### Configurando a Máquina
|
|
### Configurando a Máquina
|
|
|
|
|
|
Para o Backend, precisamos ter instalados o ambiente Node e o Docker para rodar o banco de dados da aplicação. Além disso, vamos usar o VSCode para escrita do código fonte. Esse pontos estão descritos nas configurações gerais do projeto.
|
|
Para o Backend, precisamos ter instalados o ambiente Node e o Docker para rodar o banco de dados da aplicação. Além disso, vamos usar o VSCode para escrita do código fonte. Esse pontos estão descritos nas configurações gerais do projeto.
|
|
|
|
|
|
Para instalar o Docker, vamos utilizar o guia oficial do Docker. Caso você esteja utilizando ambiente Windows, é possível utilizar o executável para instalar o Docker e o docker-compose de maneira simples. Também é recomendado habilitar o WSL2 para ter um ambiente Linux virtualizado. Isso facilita o uso do Docker além de possibilitar o desenvolvimento em uma máquina virtual rodando Linux.
|
|
Para instalar o Docker, vamos utilizar o guia oficial do Docker. Caso você esteja utilizando ambiente Windows, é possível utilizar o executável para instalar o Docker e o docker-compose de maneira simples. Também é recomendado habilitar o WSL2 para ter um ambiente Linux virtualizado. Isso facilita o uso do Docker além de possibilitar o desenvolvimento em uma máquina virtual rodando Linux.
|
... | @@ -108,13 +118,19 @@ Se você estiver utilizando Linux, o processo de instalação é um pouco difere |
... | @@ -108,13 +118,19 @@ Se você estiver utilizando Linux, o processo de instalação é um pouco difere |
|
|
|
|
|
[Docker no Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
|
|
[Docker no Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
|
|
[docker-compose](https://docs.docker.com/compose/install/)
|
|
[docker-compose](https://docs.docker.com/compose/install/)
|
|
|
|
|
|
### Compilando
|
|
### Compilando
|
|
|
|
|
|
### Executando
|
|
### Executando
|
|
|
|
|
|
## Frontend
|
|
## Frontend
|
|
|
|
|
|
### Configurando a Máquina
|
|
### Configurando a Máquina
|
|
|
|
|
|
### Compilando
|
|
### Compilando
|
|
|
|
|
|
### Executando
|
|
### Executando
|
|
|
|
|
|
Depois de clonar o repositório do GitLab para a sua máquina, acesse o projeto pelo terminal (pode ser diretamente pelo terminald o VS Code) e execute `npm install`. Esse comando irá fazer o download e todas dependências do projeto (esse comando pode demorar bastante para ser executado, então não se preocupe).
|
|
Depois de clonar o repositório do GitLab para a sua máquina, acesse o projeto pelo terminal (pode ser diretamente pelo terminald o VS Code) e execute `npm install`. Esse comando irá fazer o download e todas dependências do projeto (esse comando pode demorar bastante para ser executado, então não se preocupe).
|
|
|
|
|
|
Para visualizar o que já foi feito, basta executar o seguinte comando no terminal `npm start`.
|
|
Para visualizar o que já foi feito, basta executar o seguinte comando no terminal `npm start`.
|
... | | ... | |