Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ohbarye/kpt-bot
Slack bot to encourage KPT retrospect ðŸ’
https://github.com/ohbarye/kpt-bot
bot javascript slack
Last synced: about 2 months ago
JSON representation
Slack bot to encourage KPT retrospect ðŸ’
- Host: GitHub
- URL: https://github.com/ohbarye/kpt-bot
- Owner: ohbarye
- Created: 2016-12-14T17:10:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:28:05.000Z (about 2 years ago)
- Last Synced: 2024-04-14T12:32:08.149Z (9 months ago)
- Topics: bot, javascript, slack
- Language: JavaScript
- Homepage: https://hub.docker.com/r/ohbarye/kpt-bot/
- Size: 859 KB
- Stars: 27
- Watchers: 6
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slack bot for KPT retrospect
## What's this?
It's a Slack bot to encourage us KPT retrospect.
## Usage
- Post any messages starting with "K " or "P " or "T " as like...
- "K Found a good restaurant near our office"
- "P This project is getting delayed..."
- "T Start daily meeting"
- Call your KPT bot when you want to start retrospect with posted KPTs.
### Format
`@bot-name summary $from_date $to_date`
- from_date: Optional. Start of a time range of messages.
- to_date: Optional. End of a time range of messages.
### Sample
`@bot-name summary 2016-11-01 2016-11-30`
The bot gathers KPTs you posted from 2016-11-01 and 2016-11-30 from a history of a channel you called the bot.
## Why not use another tool?
Actually, there are many tools to do it, but most of them are not for "daily use".
We think of good ideas anytime we live. To memorize them, you open your laptop and start the app or website to record your ideas. If you're out and do not have a good device to do it... Ugh, that's tiresome.
Slack is now our "daily use" tool and there are fewer barriers to prevent us to track our KPTs.
## Develop
```sh
$ git clone [email protected]:ohbarye/kpt-bot.git
$ npm install -g yarn && yarn
$ SLACK_BOT_TOKEN=your-slack-bot-token yarn start
```
## Deployment
If you want to deploy to Heroku, just click following button.
[](https://heroku.com/deploy)
### Run with Docker
Pull the Docker image and run with your Slack bot token.
```bash
docker pull ohbarye/kpt-bot
docker run -e SLACK_BOT_TOKEN=your-slack-bot-token ohbarye/kpt-bot
```
## Environment Variables
### SLACK_BOT_TOKEN (required)
Slack bot API token.
If you do not have it yet, visit https://my.slack.com/services/new/bot and get the token.