jocrah/hypefalcon

HypeFalcon

About

Hypefalcon is a Slackbot that allows you to create a recognition of someone else's efforts and to make it available through a simple Slack command.

Features

• Users can recognize teammates' efforts

• Users can modify/edit the recognition

• Users can delete a recognition

• Users may display the most recent hypes

• Users may display a teammate's notable recognitions over time

Requirements

1. MongoDB
2. Slack app, Create one here.
3. Adding Slash command (\kudo) for app

Setup

Clone the project

  git clone https://github.com/jocrah/hypefalcon

Go to the project directory

  cd hypefalcon

Install dependencies

  npm i

To run this project, you will need to add the following environment variables to your .env file

MONGODB_URL

SLACK_OAUTH_TOKEN

Start the server

  npm run start

Expose server on served port via ngrok or any preferred tool and update the Request URL field under the earlier added slack command.

It should have the following format

https://<generated-url>/kudos/slack

Usage

• User can recognize a team member's effort using the Slack command: /kudo add <slack-id> <text> where:

  • <slack-id> defines the individual receiving the recognition
  • <text> is your kudo for that person

• User can modify/edit kudo using the Slack command: /kudo replace <kudo-id> <text> where:

  • <action> is 'replace' or 'delete'
  • <kudo-id> is the kudo identifier
  • <text> is your kudo for that person

• User can delete a kudo using the Slack command: /kudo delete <kudo-id>

• User may display the most recent n kudos using the Slack command: /kudo list <n> where n is an integer or * for all kudos

• User may display all kudos for an individual with the Slack command: /kudo user <slack-id>

Running Tests

To run tests, run the following command

  npm run test

Tech Stack

Node, Express, MongoDB

hypefalcon's Issues

set up testing

set up testing for code

add help command

add help command

implement replace command

implement replace command

Spec

• - User can modify a kudo using the Slack command: /kudo replace <kudo-id> <text> where:

  • <kudo-id> is the kudo identifier
  • <text> is your kudo for that person

implement list command

Spec

User may display the most recent n kudos using the Slack command: /kudo list <n> where n is an integer or * for all kudos

return well formatted data to slack based on command

Description

return well formatted data to slack based on command

implement delete command

Description

User can delete a kudo using the Slack command: /kudo delete <kudo-id>

add tests to commands and api

add tests to commands and api

integrate ci (github actions)

integrate ci (github actions)

restructure db to be generic

restructure db to be generic

look into deploying/publishing app

look into deploying/publishing app

implement top command

Spec

User may list the individual having the most kudos, in descending order, user the Slack command: /kudo top <n> where n is an integer or * for all individuals who have received a kudo

implement user command

Spec

User may display all kudos for an individual with the Slack command: /kudo user <slack-id>

add health route

Describe

Currently, a convenient way is needed to know the application is up and healthy. In view of this, a health route is needed.

This health route will check on the resources needed for the app to function (in this case, the database) and use that to ascertain that the app is functioning as expected