Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iam-mhaseeb/StandupMonkey
A self hosted slack bot to conduct standups & generate reports.
https://github.com/iam-mhaseeb/StandupMonkey
open-source opensource python python-3 python3 self-hosted slack slack-bot slackbot standup standup-bot standup-meetings standup-report standup-slackbot
Last synced: 3 months ago
JSON representation
A self hosted slack bot to conduct standups & generate reports.
- Host: GitHub
- URL: https://github.com/iam-mhaseeb/StandupMonkey
- Owner: iam-mhaseeb
- License: gpl-3.0
- Archived: true
- Created: 2021-05-31T17:40:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-26T01:53:42.000Z (over 3 years ago)
- Last Synced: 2024-06-28T05:38:56.132Z (4 months ago)
- Topics: open-source, opensource, python, python-3, python3, self-hosted, slack, slack-bot, slackbot, standup, standup-bot, standup-meetings, standup-report, standup-slackbot
- Language: Python
- Homepage: https://standup-monkey.herokuapp.com/slack/install
- Size: 48.8 KB
- Stars: 72
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
StandupMonkey
A self hosted slack bot to conduct standups & generate reports.
Report Bug
·
Request Feature
[](https://www.gnu.org/licenses/gpl-3.0)
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
4. Select **Create New App**
5. Choose **From an app manifest**
6. Select your workspace
7. Copy yaml from [here](https://github.com/iam-mhaseeb/StandupMonkey/blob/main/manifest/app.yml) paste it in a code editor
8. Replace https://standup-monkey.herokuapp.com with your server base url (example: https://yourwebsite.com)
9. Paste it in opened modal and click next
10. Click create and app will be created in your workspace
11. Go to manage your app screen & select **Basic Information**
12. Setup your postgres database on your desired service
13. Navigate to **App Credentials** section
14. 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**
15. Add your newly added bot to your required channel
16. 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](https://github.com/iam-mhaseeb)
## Licensing
The project is [GPL-3.0 License](LICENSE).