Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.19 KB

README.md

File metadata and controls

68 lines (49 loc) · 2.19 KB
Raw

Poker Planner for Slack

This project lets you make estimations with planning poker technique (or scrum poker) directly in Slack, without any need of external software. It can be a useful tool for agile remote teams.

Slack App Directory: https://pokerplanner.slack.com/apps/A57FFS3QE-poker-planner

Demonstration

Installation & Add to your Slack Team

Usage

For detailed usage documentation, please visit website.

Self-hosting

If you want to host your own app, follow this steps:

Creating Slack App & Getting Credentials

  • Create a new Slack app from here.
  • Interactivity & Shortcuts
    • Turn on "Interactivity"
    • Set request url: http://my.awesome.project.url/slack/interactivity
  • Slash Commands
    • Create a new command /pp (or any command you want) and set request url as http://my.awesome.project.url/slack/pp-slash-command
    • Make sure that "Escape channels, users, and links sent to your app" option is turned on
  • OAuth & Permissions
    • Add a new OAuth Redirect URL: http://my.awesome.project.url/oauth
    • Required bot permission scopes: commands, chat:write
    • Required user permission scopes: None
  • User ID Translation
    • Turn off "Translate Global IDs"
  • Tokens
    • Client ID, Secret and Verification token can be found on Basic Information page
  • Installation
    • Go to Manage Distribution, click "Add to Slack" and grant permissions

Running via Docker

docker run \
  --publish 3000:3000 \
  --env SLACK_CLIENT_ID="xxx" \
  --env SLACK_CLIENT_SECRET="xxx" \
  --env SLACK_VERIFICATION_TOKEN="xxx" \
  dgurkaynak/slack-poker-planner:latest

Running Manually

Node.js requirement >= 12.17.0

  • Clone this repo
  • Install dependencies: npm i
  • Build: npm run build
  • Start the app: npm start

Environment variables

Check out .env file.