Instalação

Esse guia apresenta a instalação da ferramenta no ambiente de desenvolvimento local.

Ambiente de desenvolvimento local

📋 Requisitos

• NodeJS v18.3.0 LTS / NPM v8.11 (recomenda-se fortemente a utilização do NVM para gerenciar facilmente as versões do NodeJS)
• Yarn
• Credenciais do Firebase (siga as instruções no guia de instalação abaixo para gerar as credenciais)

🔧 Instalação

• Clone o repositório

git clone https://github.com/intrig-unicamp/paths-viewer.git
cd paths-viewer # entre na pasta onde foi feito o clone

• Configure as credenciais do Firebase de acordo com esse guia

• (se utilizar NVM): Configure a versão NodeJS correspondente

nvm install
nvm use # necessário executar sempre que for iniciar o projeto

• Instale as dependências do projeto

yarn install

• Inicie o projeto no modo desenvolvedor

yarn dev

Por padrão, a interface deverá iniciar no endereço http://localhost:3000.

Scripts

• yarn dev
  Executa o projeto no modo de desenvolvimento. Abra o endereço http://localhost:3000 no navegador para usar o projeto localmente.

  A página vai recarregar a medida que os arquivos do projeto forem atualizados.
  Eventuais erros e avisos de linting são reportados no console.

• yarn build
  Realiza o bundle e otimização da aplicação para produção na pasta build.

• yarn start
  Serve a aplicação compilada na pasta build no endereço http://localhost:3000.

  Mudanças no código não disparam atualizações no código compilado. É necessário executar yarn build com sucesso antes desse comando.