Página de Configuração do Projeto

Aqui deve ser explicado como configurar o Ambiente para que os Desenvolvedores do Projeto possam configurar o projeto para rodar em seus computadores, deve ser sempre atualizado a cada mudança de instalação feita.

• Deve ser explicado a configuração de TODAS as partes do projeto, tanto BACK,BANCO,FRONT,etc...
• Além de explicar aqui, deve ter em cada Repositório o RESUMO de como instalar para quando os Desenvolvedores baixarem o projeto possam configurar por lá também

O projeto é essencialmente composto por um backend constituído formado por dois serviços (Springboot), um banco de dados relacional (Postgres), e uma aplicação web de frontend (React).

Backend e Banco de Dados

O repositório de backend engloba o código dos dois serviços, e scripts SQL para setup do banco de dados, tudo conteinerizado com Docker e Docker-compose.

Para rodar localmente os serviços listados e o banco de dados correspondente, pode ser utilizado o docker-compose.yml que está configurado para rodar os 3 contâineres Docker.

Requisitos:

• Ter o Docker e o Docker Compose instalados na máquina.
• Se você utiliza Linux, use o comando sudo apt install docker docker-compose -y.
• Ter o Gradle instalado na máquina (apenas para execução local/na IDE durante desenvolvimento, pois para rodar nos contêineres não é necessário devido à configuração prévia do mesmo).
• configuração da integração do serviço de chatbot com conta e página do facebook.

Configurando o chatbot

A seguir será apresentado o resumo de configuração do chatbot, mas para uma melhor compreensão existe uma versão detalhada.

• Primeiramente, baixe um programa chamado Ngrok (caso conheça algum outra forma de expor sua porta 8080 para o mundo, sinta-se a vontede de utilizá-la).

• Feito isso, execute o comando no terminal ngrok http 8081, ao fazer isso sua porta está exposta pelo link gerado que estará mostrando no seu terminal, por 8 horas.

• Configure ou use um app no FacebookDevelopers e vincule à sua página do facebook (mais detalhes aqui).

• Vá em Access Token e pressione Generate Token

• No popup aberto, leia o que está escrito e pressione I Uderstand

• Copie o token gerado e cole no campo facebook.app.access.token= presente no arquivo de propriedades do serviço de chatbot.

  • Na caixa de diálogo aberta, coloque no primerio input, o link https gerado no terminal + /webhook
    • ex: https://5f90600d.ngrok.io/webhook
  • No segundo input, escreva tokenToVerify
    • esse token está configurado no application.properties com o campo facebook.verify.token.

• Feito isso, quando a aplicação rodar, deve ser possível receber e responder requisições de qualquer conversa de chat da página associada.

Rodando

• Execute o arquivo start.sh como administrador:
  • primeiro é necessário dar permissão de execução ao script: chmod +x start.sh
  • Execute o script: sudo ./start.sh
• Note que o arquivo start.sh faz o build de cada projeto e depois inicia o contâineres docker.'
  • O solucao-de-problemas-service estará disponível em http://localhost:8080/
  • O chatbot-service estará disponível em http://localhost:8081/
  • A base de dados no postgres estará disponível para acesso externo em postgresql://localhost:5555/incluitech (mas internamente já está configurado para os contêineres acessarem o banco por postgresql://incluitech-postgres:5432/incluitech).

Frontend

Para rodar o frontend da aplicação, basta executar os seguintes comandos na raiz do projeto:

cd incluitech-frontend npm install ou yarn install npm start ou yarn start