Slack karma bot written in Elixir
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
rel
test
.gitignore
CHANGELOG.md
Dockerfile
README.md
mix.exs
mix.lock
sshot.png

README.md

Elkarmo

Slack karma bot written in Elixir. Allows to add (or remove) karma points to other teammates.

screenshot

  • Use @mention followed by ++ or -- (up to 5 +/-) to add/remove karma points to selected user.
  • Talk to the bot directly or use simple mention to display the current stats.
  • Say version to the bot to get the version number.
  • Use @your_bot_name: reset to reset karma stats.

Karma points are stored using DETS in karma_db file.

This project uses the Elixir-Slack library to communicate with Slack.

There is a blog-post which describes how this bot was built.

Installation

  • Create a new bot user for your Slack team.
  • Get the token for your newly created bot and paste it in the configuration config/config.exs:
config :elkarmo, slack_token: "YOUR_SLACK_TOKEN_HERE"
  • You can run the app via mix run --no-halt, iex -S mix or create a redistributable package using exrm (mix release).