Skip to content

Latest commit

 

History

History
executable file
·
168 lines (125 loc) · 9.37 KB

README.md

File metadata and controls

executable file
·
168 lines (125 loc) · 9.37 KB
Raw

Projeto Chatbot para Brasil Participativo

Bem-vindo ao repositório oficial do projeto Chatbot para o Brasil Participativo! Este projeto faz parte de uma iniciativa para enriquecer a experiência na plataforma digital do Brasil Participativo, uma plataforma de participação social do governo federal.

Sobre o Brasil Participativo

O Brasil Participativo é uma plataforma desenvolvida em software livre, com o apoio da Dataprev, colaboração da comunidade Decidim-Brasil, parceria com o Ministério da Gestão e Inovação em Serviços Públicos (MGI) e envolvimento da Universidade de Brasília (UnB). A plataforma visa permitir que a sociedade contribua ativamente para o desenvolvimento e aprimoramento das políticas públicas.

Sobre o Projeto Chatbot

O foco central deste projeto é a implementação de um chatbot destinado a orientar os usuários durante a navegação na plataforma do Brasil Participativo, com o objetivo de esclarecer dúvidas comuns, fornecer suporte e e informar sobre os processos de participação na plataforma em tempo real. O projeto possui médio porte e complexidade, ele necessita de habilidades em Chatbot e Evolução de Software Livre, com Giovanni Alvissus atuando como mentor.

As principais tecnologias utilizadas no projeto serão o JavaScript, devido à sua ampla aceitação e eficácia na construção de aplicações interativas, e o Botpress, que oferece uma plataforma robusta e extensível para o desenvolvimento de chatbots com inteligência artificial. O Botpress facilita a integração de funcionalidades avançadas, permitindo uma interação mais natural e eficiente com os usuários.

Além disso, como o projeto Chatbot de Participação Social será um plugin para a Plataofrma do Brasil Participativo, ele poderá ser utilizado em outros projetos que utilizam a plataforma digital Decidim. Abaixo temos uma captura de tela do chatbot operando no servidor de teste do site Brasil Participativo. imagem_telegram

O vídeo abaixo é uma demonstração detalhada do funcionamento do nosso Mínimo Produto Viável (MVP) para o site Brasil Participativo. Este vídeo mostra a interface do usuário diretamente no site, onde o chatbot está integrado para melhorar a experiência do usuário.]

Demonstração do projeto

Colaboradores e Parceiros

Este projeto é fruto da colaboração entre a empresa BRISA, o Ministério da Ciência, Tecnologia e Inovação (MCTI) e a Universidade de Brasília. Agradecemos a todos os envolvidos por contribuírem para a evolução do Brasil Participativo.

Sinta-se à vontade para explorar o código-fonte, relatar problemas (issues) e contribuir para o aprimoramento deste projeto. Juntos, estamos construindo uma plataforma mais acessível e interativa para a participação ativa da sociedade.

Desenvolvedores

Gabriel Santos Pinto
Gabriel Pessoa Zaranza
Gabriel Reis Scheidt Paulino
Isaque Augusto da Silva Santos
Thiago Henrique Marques Rocha
Arthur Taylor de Jesus Popov

Getting Started

Este projeto foi desenvolvido no Ubuntu LTS 22.04. Pode funcionar em outros sistemas operacionais, mas ainda não foi testado. Para rodar o projeto, siga as instruções abaixo:

Pré-requisitos

Certifique-se de estar com o sistema atualizado, no terminal rode o seguinte comado:

    sudo apt update && sudo apt upgrade

Antes de iniciar, certifique-se de que você tenha os seguintes softwares instalados na sua máquina:

Passo 2: Clonar o Repositório

  1. Abra o terminal ou prompt de comando.
  2. Clone o repositório usando o comando:
    git clone https://github.com/ResidenciaTICBrisa/T2G2-Chatbot-Participacao-Social

Passo 3: Configurar o Arquivo .env

  1. Crie um arquivo .env no diretório raiz do projeto.

  2. Abra o arquivo .env com seu editor de texto preferido.

  3. Adicione a seguintes linhas ao arquivo .env e substitua os '*' pelas credenciais que deseja criar no botpress:

    #Credenciais do postgres
POSTGRES_DB= * #Nome do dbanco de dados
POSTGRES_USER= * #Usuário postgress
POSTGRES_PASSWORD= * #Senha do usuário postgres

#Credenciais da conta de administrador do pgadmin
PGADMIN_DEFAULT_EMAIL= * #email do usuário pgadmin
PGADMIN_DEFAULT_PASSWORD= * #Senha do usuário pgadmin

#Credencias da conta administrador do botpress
BOTPRESS_ADMIN_EMAIL= * #Email da conta administrador
BOTPRESS_ADMIN_PASSWORD=* #Senha da conta administrador

Passo 4: Executar o docker compose

De o seguinte comando para rodar o sistema:

    docker compose -f docker-compose-local.yml up

Passo 5: Acessar o sistema

Se tudo tiver sido da forma adequada, acesse o projeto através do http://localhost:3000

Onde Buscar Informações

Se você está utilizando ou explorando o Botpress versão 12, aqui estão alguns recursos importantes para ajudar na sua jornada:

  • Documentação Oficial (v12:latest): Para acessar a documentação mais recente do Botpress v12, visite Documentação Botpress v12:latest.

  • Documentação Botpress v12.26.7: Caso esteja trabalhando especificamente com a versão v12.26.7, a documentação correspondente pode ser encontrada em Documentação Botpress v12.26.7.

  • Repositório no GitHub: Para acessar o código-fonte e contribuir para o desenvolvimento, acesse o repositório oficial do Botpress v12 no GitHub: GitHub Botpress v12.

Certifique-se de explorar esses recursos para obter todas as informações necessárias sobre o Botpress e seu uso!

Documentação