carrots

command module
v0.0.0-...-e2ee9bb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

README

Carrots

Golang KudosBot for Slack

Installation

  • Setup the Bots app for you slack workspace: https://app.slack.com/apps/A0F7YS25R-bots?next_id=0, save the token somewhere secret

  • Create the MySQL db, I have included the commands I used

  • Update the carrots.json file

  • Build the app

    go get github.com/rgarth/carrots
    go build github.com/rgarth/carrots
    cp $GOPATH/src/github.com/rgarth/carrots/carrots.json ./
    
  • Run the app

    SLACKTOKEN=[SLACK-TOKEN] MYSQLPASS=[DB-PASSWORD] ./carrots
    
  • Invite the bot to your channel

Configuration

All config options are in carrots.json. "Limits", is the number of emoji a user can send in a calendar month, -1 removes the limit

Usage

Commands

@kudos help Get help, only visible to the message sender
@kudos ladder Print the monthly leaderboard
@kudos me Print your personal monthly stats, only visible to the message sender

Sending Kudos
@<person> <emoji>
or
<emoji> @<person1> @<person2>
or
Some <emoji> <emoji> are due to @<person> for being awesome

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL