Skip to content

Latest commit

 

History

History
163 lines (118 loc) · 8.35 KB

README.md

File metadata and controls

163 lines (118 loc) · 8.35 KB

AlligaBot

GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub branches GitHub repo size GitHub contributors Open Source Love svg2

💻 Visão Geral

O AlligaBot propõe-se a ajudar a combater desinformação no contexto da pandemia do COVID-19, facilitando a divulgação de informações importantes através de um chat bot que responderá as dúvidas mais frequentes.

💡 Ideia e Incentivo

Com o decorrer da pandemia percebemos a preocupante e crescente desinformação da população, e quando tal fato está relacionado a uma pandemia global é extremamente perigoso. Por isso achamos necessária a divulgação de informações pertinentes sobre a COVID-19 para informar a população e, de alguma forma, ajudar no combate mundial ao vírus.

📦 Releases

Release 1 - 14 de setembro

Release 2 - 28 de outubto

🚀 Como executar o projeto

🛠 Tecnologias e Pré-Requisitos

Esse projeto usa algumas ferramentas para o seu desenvolvimento:

Você pode assistir esse vídeo para instalar as ferramentas do Docker e o WSL no Windows 10. Além disso, note que Docker Compose é um programa diferente do Docker e deve ser instalado separadamente.

✔️ Instalando e executando

Baixe o repositório e entre nele

git clone https://github.com/fga-eps-mds/2021.1-AlligaBot.git
cd 2021.1-AlligaBot

Crie um arquivo para as variáveis ambiente e o preencha com as informações que faltam.

cp .example.env .env

Para preencher essas variáveis, dê uma olhada na seção da FAQ "Onde conseguir os tokens e as variáveis de ambiente?". Faça build das imagens rodando o seguinte comando:

make build 

Se esta é a sua primeira vez executando esse comando, isso pode levar alguns minutos. Em seguida suba os contêineres com

make run

Então, treine o bot executando:

make train

Para conversar com o chatBot, execute o seguinte:

make shell

Para sair do shell, digite /stop ou faça Ctrl+C. Não se esqueça de desligar os containers quando terminar sua sessão de desenvolvimento. Para desligar os contêineres basta executar:

make stop

Se você quiser adicionar novos diálogos ao AlligaBot você deve fazer alterações no arquivos bot/domain.yml e bot/data/*.yml, e, em seguida, deve treiná-lo novamente:

make train

🤝 Como contribuir para o projeto

Guia de Contribuição

Código de Conduta

Política de Branches

Políticas de Commits

Template para criação de issues

Template para criação de pull requests

👨‍💻 Desenvolvedores

Capivaras 🐗


Ana Carolina


Kathlyn Lara


Lameque Fernandes


Matheus Sousa


Thais Rebouças

Plus Ultra 🔋


Amanda Nobre


Erick Levy


Douglas Monteles


Victor Eduardo


Pedro Lucas


Yudi Yamane

Slowbrows 🐌


Henrique Hida


Kayro Cesar

📝 Licença

Este projeto está licenciado sob os termos da licença GNU GPL v3.0.