Skip to content
This repository has been archived by the owner on Mar 5, 2023. It is now read-only.
/ StandupMonkey Public archive

A self hosted slack bot to conduct standups & generate reports.

License

Notifications You must be signed in to change notification settings

iam-mhaseeb/StandupMonkey

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Standup Monkey

StandupMonkey

A self hosted slack bot to conduct standups & generate reports.

Report Bug · Request Feature

StandupMonkey - A self hosted slack bot to conduct standups. | Product Hunt

Contributors Issues License: GPL v3 Forks Stars

Installation

  1. Install already hosted bot (Use this for only testing purpose)

Add to Slack

  1. Deploy on your own server (Recommended)
    1. Clone this repoistory and deploy on server of your choice
    2. Go to https://api.slack.com/apps
    3. Select Create New App
    4. Choose From an app manifest
    5. Select your workspace
    6. Copy yaml from here paste it in a code editor
    7. Replace https://standup-monkey.herokuapp.com with your server base url (example: https://yourwebsite.com)
    8. Paste it in opened modal and click next
    9. Click create and app will be created in your workspace
    10. Go to manage your app screen & select Basic Information
    11. Setup your postgres database on your desired service
    12. Navigate to App Credentials section
    13. Set the following enviornment variables:
      • Client ID as SLACK_CLIENT_ID
      • Client Secret as SLACK_CLIENT_SECRET
      • Signing Secret as SIGNING_SECRET
      • Slack bot token as SLACK_BOT_TOKEN Yes, we need it really :( files upload doesn't work without it.
      • Database host as HOST
      • Database user as USER
      • Database password as PASSWORD
    14. Add your newly added bot to your required channel
    15. You standup bot is now ready to use 🎉

Quick start

  1. Go to StandupMonkey messages
  2. Type /standup image
  3. Fill details in the input boxes and press enter to submit each input image Note: Make sure StandupMonkey is added to the channel in which you are trying to post your standup status
  4. StanupMonkey will post submitted standup status to selected channel automatically image
  5. Type /generate-report @user start_date end_date to generate CSV report of standup statuses of a user image Note: Start date & date should be in the format: YYYY-MM-DD
  6. Your generated report will be something like this image

Authors

Licensing

The project is GPL-3.0 License.