{"id":17163769,"url":"https://github.com/mmcdole/heyemoji","last_synced_at":"2025-04-13T14:42:58.531Z","repository":{"id":47550969,"uuid":"282110470","full_name":"mmcdole/heyemoji","owner":"mmcdole","description":"a slack recognition bot","archived":false,"fork":false,"pushed_at":"2023-02-16T05:05:04.000Z","size":39,"stargazers_count":11,"open_issues_count":8,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T05:41:36.598Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmcdole.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-07-24T03:11:14.000Z","updated_at":"2023-10-18T02:21:26.000Z","dependencies_parsed_at":"2023-02-15T13:15:49.217Z","dependency_job_id":"8cd87492-658b-404d-be8d-63d35d99c267","html_url":"https://github.com/mmcdole/heyemoji","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmcdole%2Fheyemoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmcdole%2Fheyemoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmcdole%2Fheyemoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmcdole%2Fheyemoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmcdole","download_url":"https://codeload.github.com/mmcdole/heyemoji/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248731696,"owners_count":21152838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T22:49:59.008Z","updated_at":"2025-04-13T14:42:58.504Z","avatar_url":"https://github.com/mmcdole.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# heyemoji 🏆 👏 ⭐\n# \n\n![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/mmcdole/heyemoji) [![Go Report Card](https://goreportcard.com/badge/github.com/mmcdole/heyemoji)](https://goreportcard.com/report/github.com/mmcdole/heyemoji) [![Doc](https://godoc.org/github.com/mmcdole/heyemoji?status.svg)](http://godoc.org/github.com/mmcdole/heyemoji) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)\n\nThe `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.\n\n## Table of Contents\n\n- [Usage](#basic-usage)\n- [Setup](#setup)\n- [Configuration](#configuration)\n\n## Basic Usage\n\n#### Give a single user emoji points \n\n`Great job filling out those TPS reports @michael.bolton! ⭐` \n\n#### Give multiple users emoji points\n\n`Thanks @michael.bolton and @samir for coming in this weekend! ⭐`\n\n#### Give multiple emojis to a user\n\n`Score! @petergibbons found my red stapler! ⭐ 🏆 👏 👏 `\n\n### Bot Commands\n\n| Name                   | Description                                                |\n|------------------------------------------|------------------------------------------------------------|\n| `leaderboard \u003cday\\|week\\|month\\|year\u003e`   | see the top 10 people on your leaderboard                  |\n| `points`                                 | see how many emoji points you have left to give            |\n| `help`                                   | get help with how to send recognition emoji                |\n\n## Setup\n\n1. Browse to https://api.slack.com/apps?new_classic_app=1\n2. Assign a name and workspace to your new Slack Bot Application\n3. `Basic Information` \u003e Set display name and icon\n4. `App Home` \u003e Add Legacy Bot User\n5. `OAuth \u0026 Permissions` \u003e Install App to Workspace\n6. Copy your **Bot User OAuth Access Token** for your `HEY_SLACK_API_TOKEN`\n7. Run `heyemoji` specifying the above token! 🎉\n\n## Configuration\n\n| ENV Var             | Default  | Required | Note                                                          |\n|---------------------|----------|----------|---------------------------------------------------------------|\n| HEY_BOT_NAME        | heyemoji | No       | The display name of the heyemoji bot                          |\n| HEY_DATABASE_PATH   | ./data/  | No       | The directory that the database files should be written to    |\n| HEY_SLACK_TOKEN     |          | Yes      | The API tokens for the Slack API                              |\n| HEY_SLACK_EMOJI     | star:1   | No       | Comma delimited set of emoji \"name:value\" pairs               |\n| HEY_SLACK_DAILY_CAP | 5        | No       | The max number of emoji points that can be given out in a day |\n| HEY_WEBSOCKET_PORT  | 3334     | No       | Port that the Slack RTM client will listen on                 |\n\n\n### Specifying Custom Reward Emoji\n\nThe `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:\n\n| Emoji         | Value  |\n|---------------|--------|\n| ⭐             | 1      |\n| 👏             | 2      |\n| 🏆             | 3      |\n\nYou would specify the `HEY_SLACK_EMOJI` as: `star:1,clap:2,trophy:3`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmcdole%2Fheyemoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmcdole%2Fheyemoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmcdole%2Fheyemoji/lists"}