Light

mmcdole / heyemoji Goto Github PK

View Code? Open in Web Editor NEW

11.0 4.0 6.0 39 KB

a slack recognition bot

License: MIT License

Go 97.87% Dockerfile 2.13%

heyemoji's Introduction

heyemoji 🏆 👏 ⭐

The heyemoji bot is a self-hosted slack reward system that allows team members to recognize eachother for anything awesome they may have done. This is accomplished by mentioning a user's slack @username in a channel along with a pre-configured reward emoji and an optional description of what they did. The emoji points bestowed to users can be tracked via leaderboards.

Table of Contents

Usage
Setup
Configuration

Basic Usage

Give a single user emoji points

Great job filling out those TPS reports @michael.bolton! ⭐

Give multiple users emoji points

Thanks @michael.bolton and @samir for coming in this weekend! ⭐

Give multiple emojis to a user

Score! @petergibbons found my red stapler! ⭐ 🏆 👏 👏

Bot Commands

Name	Description
`leaderboard <day\|week\|month\|year>`	see the top 10 people on your leaderboard
`points`	see how many emoji points you have left to give
`help`	get help with how to send recognition emoji

Setup

Browse to https://api.slack.com/apps?new_classic_app=1
Assign a name and workspace to your new Slack Bot Application
Basic Information > Set display name and icon
App Home > Add Legacy Bot User
OAuth & Permissions > Install App to Workspace
Copy your Bot User OAuth Access Token for your HEY_SLACK_API_TOKEN
Run heyemoji specifying the above token! 🎉

Configuration

ENV Var	Default	Required	Note
HEY_BOT_NAME	heyemoji	No	The display name of the heyemoji bot
HEY_DATABASE_PATH	./data/	No	The directory that the database files should be written to
HEY_SLACK_TOKEN		Yes	The API tokens for the Slack API
HEY_SLACK_EMOJI	star:1	No	Comma delimited set of emoji "name:value" pairs
HEY_SLACK_DAILY_CAP	5	No	The max number of emoji points that can be given out in a day
HEY_WEBSOCKET_PORT	3334	No	Port that the Slack RTM client will listen on

Specifying Custom Reward Emoji

The HEY_SLACK_EMOJI setting lets you specify multiple different reward emoji as well as different point values for each. So, if you wanted the following emoji and reward values:

Emoji	Value
⭐	1
👏	2
🏆	3

You would specify the HEY_SLACK_EMOJI as: star:1,clap:2,trophy:3

heyemoji's People

Contributors

Stargazers

Watchers

Forkers

pradeepnnv bitovi phillyphenning wovnio yeshwanthpentakota ouchsaraysb

heyemoji's Issues

Interactive Leaderboard Command

It would be nice if the leaderboard command asked for a dropdown, which then had selections for different time periods (day, week, month, year).

Right now you have to provide the timespam as part of the command.

Create "learn more" buttons in DMs when a person first gives or receives a taco.

When a person first receives or gives a taco, it would be nice if they receive a DM with a "learn more" button / message that perhaps shows the "help" message, etc.

If they receive or give a second emoji, they should no longer receive this message.

Slack upgrade issues - Push Events being responded to multiple times

We've captured more information in our fork's issue: bitovi#18
I just wanted to bubble the info up to the main repo here :)

Interactive Slack App Home

Slack Apps can have a "Home" tab.

It would be nice if HeyEmoji showed a home screen with an interactive leaderboard (defaulted to month).

Create Interactive Slack Bot "Home"

Slack Apps can have a "Home" tab.

It would be nice if HeyEmoji showed a home screen with an interactive leaderboard (defaulted to month).

Create a command / setting that allows a user to turn off bot IMs

Some users may not want to receive IMs when they hand out emoji points. It would be nice if there were a settings command that has a settings dm off and settings dm on feature.

Feature: leaderboard startDate and endDate

Allow users to specify which period they want to filter leaderboard by passing startDate and endDate parameters.

Suggestion: leaderboard startDate=2022-07-01 endDate=2022-07-31

Case insensitive commands

Currently all the commands are case-sensitive. We should lowercase the strings and then check for a match, so people can type "Leaderboard" and "leaderboard".

Incorrect Leaderboard Info

At the bottom of the leaderboard command you can see the following:

This is incorrect, it needs to show: <day | week | month >, not <day | week | year>

Support a "year" leaderboard time frame

Currently we only support day, week and month time periods. It would be nice if "year" was supported.

Make the "Points" command show both points left to give and points received

People may not always make the cut-off to be on the leaderboard. It would be nice if the "points" command was changed to show not just how many points you have left to give out, but also how many you have received over a fixed time period.

Modify the JSONLineDriver so it supports reading events for more than 30 days

Today, the JSONLineDriver only reads in 30 days of events and keeps them cached in memory.

It would be nice if the driver could read/lookup events beyond this time frame (to support something like the year event), but without having the keep the entire's years worth of events in memory.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.