iam-mhaseeb/standupmonkey

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

StandupMonkey

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

Report Bug · Request Feature

Installation

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

2. 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
3. Fill details in the input boxes and press enter to submit each input 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
5. Type /generate-report @user start_date end_date to generate CSV report of standup statuses of a user Note: Start date & date should be in the format: YYYY-MM-DD
6. Your generated report will be something like this

Authors

• Muhammad Haseeb - Initial work - Muhammad Haseeb

Licensing

The project is GPL-3.0 License.

standupmonkey's Issues

Introduce Multi tenancy

Support multiple teams in 1 workplace.

Introduce more resilient database

I'm suggesting we should introduce a more resilient database as we are using SQLite right now which is not scalable. Maybe we can introduce PostgreSQL or MySQL but the issue with these relational databases is that we would be moving away from easy deployment of the bot.
Another solution is we can introduce a centralized database as well on our end.

P.S: I'm seeing we are moving towards open-source (code only) but infrastructure can't remain open source we would need to make it close source and leave the choice of deployment to the teams if they want to deploy it on their servers, for the teams who want to use our hosted bot we would need to charge them for that, sadly😞 .

Add frequency functionality for weekly or monthly only

This repo has potential and I'd like to help add features.

For people who are not needed to attend a daily standup, where would I change the frequency or introduce a function to enable that option?

1. Does this prompt the user to do a standup or does it alert someone up the organization that xyz person has not done their standup at all or was late?

Introduce Persistent Database

Introduce PostgreSQL instead of SQLite to persist data.

Can not authorize the app

Hi I'm new here and Im very excited to test this project.

I have deployed the server to Heroku, but seems that the app can not make a successful OAuth

I have already added env config

Here's the logs

Introduce 1 click to deploy on heroku

https://devcenter.heroku.com/articles/heroku-button

Create front face for StandupMonkey

We would need a landing page for StandupMonkey. I'm suggesting using this template on the gh-pages branch](https://github.com/alohe/flashy/tree/gh-pages). It can be viewed at https://alohe.github.io/flashy/.

Introduce report generation

A long due feature was exporting all standup logs as an excel sheet. We would need something in our command like below:

/standup export-logs {username} {start_date} {end_date}

or a new command

/export-logs {username} {start_date} {end_date}

This will export a CSV file with all the logs in provided dates.