Heyburrito is a slack reward system that allows slack team members to recognize and reward team members who have performed well. Reward your colleagues / friends by sending them a 🌯, each burrito is converted to points which can be showed on a scoreboard. Heyburrito is like heytaco, but free and you host it yourself.
Each burrito will increment the users "burrito" - points. And a rottenburrito will decrement "burrito" - points
Give away burrito ( 🌯 ) to a colleague if they have done something good. ...Or maybe a rottenburrito ( :rottenburrit: , emoji needed ) if they have done something bad.. :)
Ping one or several of your colleagues and give away :burritos: if they deserve it. Otherwise :rottenburrito: if not ...
Example:
This will increase chralps "burrito" - points by 3
@chralp :burrito::burrito::burrito: - awesome app!
This will decrease chralps "burrito" - points by 2
@chralp :rottenburrito::rottenburrito: - bad app...
This will increase chralps and fagges "burrito" - points by 2 ( each )
@chralp @fagge :burrito::burrito: - awesome app!
- slack ( ofc )
- mongodb
- node ( lts/dubnium )
- Go to https://yourworkspace.slack.com/apps and search for Bots.
- Add Bots ( Connect a bot to the Slack Real Time Messaging API).
- Give the bot a name, ex: heyburrito, and obtain apiToken.
- Choose how to run it => See Docker or Node section.
- Invite the new bot to your slack channels ( where you want to be able to send burritos ).
- Open and edit
docker-compose.yml
. - Set environment variables that you need / want. Check "Environment variables" for more details.
docker-compose up -d
.
( Dockerhub repo => https://hub.docker.com/r/jrewerts/heyburrito )
git clone git@github.com:chralp/heyburrito.git
cd heyburrito
npm install
cp .env.example .env
- Set environment variables that you need / want. Check "Environment variables" for more details.
npm run start
ENV Variables | Default | Required | Note |
---|---|---|---|
THEME | default | No | See Theme section |
BOT_NAME | Yes | Same botname as in Get started section | |
DATABASE_DRIVER | Yes | See database drivers section | |
MONGODB_URL | Yes* | Only requierd if DATABASE_DRIVER is mongodb | |
MONGODB_DATABASE | Yes* | Only requierd if DATABASE_DRIVER is mongodb | |
SLACK_API_TOKEN | Yes | See Get started section | |
SLACK_EMOJI_INC | Yes | Emoji to increment points. ex:( 🌯 ) | |
SLACK_EMOJI_DEC | No | Emoji to decrement points. ex:( :rottenburrito: ). Disabled if not provided | |
SLACK_DAILY_CAP | 5 | No | Defaults to 5/day |
Name | Recomended | Note |
---|---|---|
mongodb | Yes | |
array | No | Used when testing, "memmoryDB" |
You will be able to provide a link to a gitrepo. When linking to a gitrepo, heyburrito will install and use the theme. ( not working yet tho.. see issue chralp/heyburrito#37 ).
Defaults today to heyburritotheme. Heyburritotheme is a fork of https://github.com/tbleckert/cardi-burrito .
Name | Author | link |
---|---|---|
cardi-burrito | tbleckert | https://github.com/tbleckert/cardi-burrito |
If you want your theme to be on the list, create a PR or issue!
Scoreboard is accessable via localhost or host on port 3333
.