Categorygithub.com/cpu/gorfbot
module
0.0.1-rc1
Repository: https://github.com/cpu/gorfbot.git
Documentation: pkg.go.dev

# README

jackedgarf

gorfbot

CI Status Lint Status Go Report Card

:cat: a disgusting slack bot (now in Go)

Description

Gorfbot is a small Slack bot loosely based on Garfbot. It's primary distinguishing feature is being implemented in Go instead of NodeJS.

It is specifically built for a handful of very small & weird Slack communities. It probably won't work well for you & your use case. You definitely don't want to run it in your 10,000 user corporate Slack org.

Features

Basic commands:

  • !topics - List previous channel topics
  • !echo - Have Garfbot echo a message
  • !hello - Say hello to Gorf
  • !frogtip - Frog care and feeding
  • !gis - Make a Google Image Search
  • !emoji - Find someone's most used emoji/reactji
  • !mktheme - Generate a new Slack theme
  • !themes - List saved Slack themes, add new ones

Data tracking:

  • channel topic updates
    • What were the last 20 /topic's for #general?
  • emoji usage
    • e.g. who uses :wave: in messages the most?
  • reactji usage
    • e.g. who reacted :thumbsup: the most?
  • URLs matching patterns
    • e.g. number of times a certain github project URL has been shared.

Misc:

  • reaction keywords
    • e.g. react with ":wave:" whenever someone says "hi"

Usage

TODO: Documentation................

Configuration

Slack

  • TODO: describe setting up slack API access.

MongoDB

  • TODO: describe setting up MongoDB connectivity.

Google Image Search

  • TODO: describe setting up Google API access.

Development

See CONTRIBUTING.md for instructions on building Gorfbot from source and extending it with new commands.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package slack is a generated GoMock package.
No description provided by the author
No description provided by the author