Home	Escopo e Cronograma	Processo	Design/Mockups	Configuração	Arquitetura	Código	BD	Qualidade	Utilização	Contratos

Configurações do Projeto

Descrição

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

Sumário

• Configurações Gerais
  • Instalação do ambiente de programação
• Backend
  • Configurando a Máquina
  • Executando
• Frontend
  • Configurando a Máquina
  • Executando

Configurações Gerais

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

Instalação do ambiente de programação

• Instalar o VSCode: Tanto no Linux quanto no Windows é possível baixar o instalável do site oficial da Microsoft
• Instalar os plugins do VSCode: Dentro do VSCode são recomendados (não necessários) alguns plugins que vão facilitar o desenvolvimento, são eles:
  • ESLint
  • Jest
  • Jest Runner
  • Github copilot (opcional)
• Instalar Docker: Para instalar o Docker na sua máquina siga as instruções do Linux ou do Windows

Backend

Configurando a Máquina do Back

Para executar o projeto de backend alguns passos simples são necessários:

1. instalar o Node (versão 14.0)

   • No Windows use este link para download

   • No linux execute no terminal:

     sudo apt install nodejs

2. Clonar o repositório do back-end com o seguinte comando:

   git clone https://tools.ages.pucrs.br/ucon/back

3. Agora com o terminal aberto no diretório do projeto, execute o seguinte comando:

   npm i

4. Alterar o nome do arquivo .envExample para .env, ele irá carregar variáveis padrão no sistema para rotar o projeto

Rodando o Projeto do Back

Localmente

• Após a configuração do ambiente acesse o mesmo diretório do projeto e execute o seguinte comando:

  npm run dev

• Agora você pode acessar o projeto rodando localmente no endereço:

  http://localhost:3031

Docker

• Para executar o backend utilizando o Docker é muito simples, basta rodar os comandos:

  docker-compose build

  docker-compose -d up

• Pronto, agora um container do Docker está executando em segundo plano o backend no endereço:

  http://localhost:3031

Frontend

Configurando a Máquina do Front

Para a configuração do ambiente de desenvolvimento do front-end:

1. instalar o Node (versão 14.0)

   • No Windows use este link para download

   • No linux execute no terminal:

     sudo apt install nodejs

2. Instalar o Yarn para gerenciamento das dependencias do projeto com o seguinte comando

   npm install --global yarn

3. Clonar o repositório do front-end com o seguinte comando:

   git clone https://tools.ages.pucrs.br/ucon/front.git

4. Agora com o terminal aberto no diretório do projeto, execute o seguinte comando:

   yarn install

Rodando o Projeto do Front

Localmente

• Após os passos de configuração e instalação das dependências, abra o terminal no diretório do projeto e utilize o seguinte comando para iniciar o front:

  yarn start

• Agora você pode acessar o projeto rodando localmente no endereço:

  http://localhost:3000

Docker

• Para executar o backend utilizando o Docker é muito simples, basta rodar os comandos:

  docker-compose build

  docker-compose -d up

• Pronto, agora um container do Docker está executando em segundo plano o backend no endereço:

  http://localhost:3031