Skip to content

GitLab

Last edited by ESKieroff
Page history
This is an old version of this page. You can view the most recent version or browse the history.

configuracao

Home Escopo Processo Design/Mockups Gerência Estudos Arquitetura Contratos BD Qualidade Configuração Instalação Instruções Utilização Analytics

Configurações do Projeto

Descrição

Este guia fornece as instruções detalhadas para configurar e executar o projeto, incluindo as etapas para instalação e inicialização dos ambientes de desenvolvimento.

Sumário

Configurações Gerais

Esta seção abrange as instruções gerais de configuração para os ambientes de desenvolvimento.

Instalação do Ambiente de Desenvolvimento

Altamente recomendável:

  • Instalar o VSCode: Disponível para download no site oficial da Microsoft.

  • Instalar plugins úteis para o VSCode:

    • ESLint
    • Prettier
    • Jest
    • Jest Runner
    • GitHub Copilot (opcional)

  • Instalar Docker: Siga as instruções de instalação para o Linux ou Windows.

OBS: Caso encontre problemas ao usar o Docker Desktop no Windows, considere usar o Docker diretamente sobre o WSL. Confira este tutorial para saber mais. Um mini tutorial sobre como usar Docker + WSL no Windows está disponível nesta seção.

Backend

Configurando a Máquina do Backend

Para configurar o ambiente de backend, siga os passos abaixo:

  1. Instalar o Node (versão 18.0 ou superior):

    • Para Windows: Download Node.js
    • Para Linux, execute no terminal: 
      sudo apt install nodejs

  2. Clonar o repositório do backend:

    git clone https://tools.ages.pucrs.br/cp-planta/backend.git

  3. Instalar dependências:

    • Com o terminal no diretório do projeto: 
      npm i

  4. Configurar variáveis de ambiente:

    • Renomeie o arquivo .envExample para .env para carregar as variáveis padrão.

Rodando o Projeto do Backend

Modo de Desenvolvimento:

  • Após configurar o ambiente, execute o comando: 
    npm run dev
  • O projeto estará disponível localmente em:
    http://localhost:3000

Executando com Docker:

  • Para rodar o backend com Docker: 
    docker-compose build
docker-compose up -d
  • O backend será executado no endereço:
    http://localhost:3000

Frontend

Configurando a Máquina do Frontend

Siga os passos para configurar o ambiente de frontend:

  1. Instalar o Node (versão 18.0 ou superior):

    • Para Windows: Download Node.js
    • Para Linux, execute no terminal: 
      sudo apt install nodejs

  2. Instalar o Yarn para gerenciamento de dependências:

    npm install --global yarn

  3. Clonar o repositório do frontend:

    git clone https://tools.ages.pucrs.br/cp-planta/frontend.git

  4. Instalar dependências:

    • No terminal, execute: 
      yarn install

Rodando o Projeto do Frontend

Modo de Desenvolvimento:

  • Para iniciar o frontend após a configuração: 
    yarn dev
  • O frontend estará disponível localmente em:
    http://localhost:3001

Usando WSL + Docker no Windows

Passo a Passo para Configuração

  1. Ativar Recursos do Windows:

    • Acesse Painel de Controle > Programas > Ativar ou desativar recursos do Windows.
    • Marque as opções:
      • Plataforma de Máquina Virtual
      • Plataforma do Hipervisor do Windows
      • Subsistema do Windows para Linux (WSL)

  2. Reiniciar o Computador para aplicar as mudanças.

  3. Instalar WSL e Ubuntu:

    • Abra o PowerShell como Administrador.
    • Verifique as distribuições disponíveis: 
      wsl -l --online
    • Instale a distribuição desejada (exemplo: Ubuntu): 
      wsl --install -d Ubuntu

  4. Configurar o Ubuntu no WSL:

    • Abra o menu Iniciar e localize o Ubuntu.
    • Na primeira execução, crie um usuário e senha.

  5. Instalar e Configurar o Docker no WSL:

    • Atualize os pacotes: 
      sudo apt update && sudo apt upgrade
    • Instale o Docker: 
      sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io

  6. Rodar Docker sem sudo (opcional):

    • Adicione seu usuário ao grupo Docker: 
      sudo usermod -aG docker $USER
    • Reinicie o terminal para aplicar as mudanças.

  7. Testar Instalação do Docker:

    • Verifique a versão do Docker: 
      docker --version
    • Execute um contêiner de teste: 
      docker run hello-world

Agora seu ambiente está configurado e pronto para o desenvolvimento!

                                                                                                         Topo