Skip to content

mharvey83/pijero-time

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Standup Configuration And Summary Collection Helper

Creating a standup config using a Slash Command and a Dialog Modal

Use a slash command and a dialog to create a standup configuration. Once the standup is setup the selected users will receive an alert asking to answer 3 standup questions:

  • What did you do yesterday?
  • What will you do today?
  • Do you have any blockers?

Answers are saved on DB and will be sent to all of the initially selected users 5 minutes before standup as a summary

Setup

Create a Slack app

  1. Create an app at https://api.slack.com/apps
  2. Add a Slash command (See Add a Slash Command section below)
  3. Enable Interactive components (See Enable Interactive Components below)
  4. Navigate to the OAuth & Permissions page and select the following bot token scopes:
    • commands
    • chat:write
    • users:read
    • incoming-webhook
    • users:read.email
    • im:write
  5. Click 'Save Changes' and install the app (You should get an OAuth access token after the installation)

Add a Slash Command

  1. Go back to the app settings and click on Slash Commands.
  2. Click the 'Create New Command' button and fill in the following:
    • Command: /start-pijero-time or just type any command name you want
    • Request URL: Your server or Local url using ngrok + /command
    • Short description: Standup helper
    • Usage hint: [init standup configuration]

Enable Interactive Components

  1. Go back to the app settings and click on Interactive Components.
  2. Set the Request URL to your server or Local url using ngrok + /interactive.
  3. Save the change.

Enable Beta Features (this is needed for date picker)

  1. Go back to the app settings and click on Beta Features on the sidebar.
  2. Enable Beta Features.
  3. Save the change.

Run the app

  1. Get the code
    • Clone this repo and run npm install
  2. Set the following environment variables to .env.
    • SLACK_ACCESS_TOKEN: Your bot token, xoxb- (available on the OAuth & Permissions once you install the app)
    • SLACK_SIGNING_SECRET: Your app's Signing Secret (available on the Basic Information page)
  3. If you're running the app locally, run the app (npm start).

If you want to run it locally, I recommend creating a localhost tunnel with ngrok!

About

An open source standup helper for slack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%