QBot - A slack bot for unintrusive QnA handling
QBot was written to adress mainly two problems. Intrusive questions and the asking of already answered questions.
Getting Started
To deploy QBot, simply clone the repo, populate the fields in the config.yaml file and run go run .
in the root directory of the repository.
Pre-requisites
A Slack bot API token needs to be created. This can be done over at Slack's official website.
A Database also needs to be setup. QBot is utilizing the GORM library for database modeling. Which means that it's nativeley supporting MySQL, Postgres and sqlite3. For MySQL databases, populate the database fields in the config.yaml as following.
database:
type: "mysql" # Dialect e.g. sqlite3
database: "qbot" # Name of database
user: "root" # Username
password: "qbot" # Password
Supported commands
Built With
- GORM library - Object relational mapping library
- Slack - Slack API wrapper in Go
- Zerolog - For STDOUT logging
Authors
- Martin Granström - Initial work - grvlle
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details