Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fga-eps-mds/2021.1-alligabot
Projeto de desenvolvimento de um ChatBot informativo e conversacional, disponibilizado no mensageiro Telegram, que tem como objetivo aumentar a circulação de informações sobre: Vacinação, Prevenção e Políticas Públicas a respeito da COVID-19.
https://github.com/fga-eps-mds/2021.1-alligabot
bot covid19 hacktoberfest
Last synced: about 1 month ago
JSON representation
Projeto de desenvolvimento de um ChatBot informativo e conversacional, disponibilizado no mensageiro Telegram, que tem como objetivo aumentar a circulação de informações sobre: Vacinação, Prevenção e Políticas Públicas a respeito da COVID-19.
- Host: GitHub
- URL: https://github.com/fga-eps-mds/2021.1-alligabot
- Owner: fga-eps-mds
- License: gpl-3.0
- Created: 2021-07-26T12:38:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-29T00:40:00.000Z (over 2 years ago)
- Last Synced: 2024-07-08T02:43:01.247Z (7 months ago)
- Topics: bot, covid19, hacktoberfest
- Language: Python
- Homepage: https://fga-eps-mds.github.io/2021.1-AlligaBot/
- Size: 207 MB
- Stars: 6
- Watchers: 7
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
AlligaBot
## 💻 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
- [Apresentação Geral](https://youtu.be/S_MtOdIb13s)
- [Apresentação Equipe Capivaras](https://www.youtube.com/watch?v=TWQMUeZd9EY)
- [Apresentação Equipe Plus Ultra](https://www.youtube.com/watch?v=5FDRdg9cj_k)
- [Apresentação Equipe Slowbros](https://www.youtube.com/watch?v=mxh4G5HwLlE)
Release 2 - 28 de outubto
- [Apresentação Geral](https://www.youtube.com/watch?v=obGYts5OgUw)
- [Apresentação Equipe Capivaras](https://www.youtube.com/watch?v=NFjVpS1ztDw)
- [Apresentação Equipe Plus Ultra](https://www.youtube.com/watch?v=7I6uinQSSJY)
- [Apresentação Equipe Slowbros](https://www.youtube.com/watch?v=j0dtt2ndL2k)
## 🚀 Como executar o projeto
### 🛠 Tecnologias e Pré-Requisitos
Esse projeto usa algumas ferramentas para o seu desenvolvimento:
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [WSL](https://docs.microsoft.com/pt-br/windows/wsl/install-win10) para
desenvolvimento em Windows 10
- [Make](https://www.gnu.org/software/make/)
Você pode assistir esse [vídeo](https://www.youtube.com/watch?v=oQ08ZaOAiGU)
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?"](docs/_posts/2021-09-16-faq.md).
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](docs/_posts/2021-08-16-como-contribuir.md)
[Código de Conduta](docs/_posts/2021-08-21-code_of_conduct.md)
[Política de Branches](docs/_posts/2021-08-19-branches.md)
[Políticas de Commits](docs/_posts/2021-08-18-commits.md)
[Template para criação de issues](.github/ISSUE_TEMPLATE/custom.md)
[Template para criação de pull requests](.github/pull_request_template.md)
## 👨💻 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 🐌
## 📝 Licença
Este projeto está licenciado sob os termos da licença
[GNU GPL v3.0](./LICENSE).
