Ir para o conteúdo

Instalação

Este guia irá orientá-lo através do processo de configuração e execução da aplicação em seu ambiente de desenvolvimento local.

Pré-requisitos

Antes de começar, você precisará ter o seguinte software instalado em sua máquina:

  • Node.js: A aplicação é construída sobre o Node.js, que é um ambiente de execução JavaScript. A instalação do Node.js também incluirá o npm, o gerenciador de pacotes do Node.js.
  • Yarn (Opcional): Yarn é um gerenciador de pacotes alternativo ao npm. Você pode usar tanto o npm quanto o yarn para instalar as dependências do projeto.

Instalando o Node.js e o npm

Você pode baixar e instalar o Node.js a partir do site oficial. A versão LTS (Long Term Support) é recomendada para a maioria dos usuários. O npm é instalado automaticamente com o Node.js.

Para verificar se o Node.js e o npm estão instalados corretamente, abra seu terminal e execute os seguintes comandos:

node -v
npm -v

Você deverá ver as versões do Node.js and npm instaladas em sua máquina.

Instalando o Yarn (Opcional)

Se você preferir usar o Yarn, pode instalá-lo globalmente através do npm com o seguinte comando:

npm install -g yarn

Para verificar se o Yarn foi instalado com sucesso, execute:

yarn --version

Executando a Aplicação

Com os pré-requisitos instalados, siga os passos abaixo para executar a aplicação.

  1. Clone o repositório do projeto e navegue até a pasta raiz.

    git clone https://gitlab.brlight.com.br/lightbase1/lightbase-toolkit/genb.git
    

  2. Entre na pasta gen-b:

    cd gen-b
    
  3. Instale as dependências do projeto. Você pode usar o yarn ou o npm. Escolha um dos comandos abaixo:

    Com o Yarn:

    yarn
    

    Ou com o npm:

    npm install
    
  4. Inicie a aplicação de backend (genb):

    Com o Yarn:

    yarn start genb
    

    Ou com o npm:

    npm start genb
    

    Este comando irá iniciar o servidor de desenvolvimento para a aplicação principal.

  5. Inicie a aplicação de frontend (genb-ui):

    Em um novo terminal, navegue novamente até a pasta gen-b e execute o seguinte comando para iniciar a interface do usuário:

    Com o Yarn:

    yarn start genb-ui
    

    Ou com o npm:

    npm start genb-ui
    

    Após a execução deste comando, o frontend da aplicação estará disponível em seu navegador, geralmente em um endereço como http://localhost:4200/.

Agora você tem o ambiente de desenvolvimento completo em execução. O backend (genb) e o frontend (genb-ui) estão rodando em processos separados.