Kudobot - Powered by Bolt

This project is a kudobot app that generates kudo messages based on user input.

Bolt

Bolt is a Slack framework that lets you build JavaScript-based Slack apps in a flash.

Read Getting Started with Bolt guide for a more in-depth tutorial on Bolt.

Read the Bolt documentation for full documentation.

About the app

• app.js contains the primary Bolt app. It imports the Bolt package (@slack/bolt) and starts the Bolt app's server. It's where we add app listeners.
• .env is where we put your Slack app's authorization token and signing secret. As usual, do not check sensitive secrets in to version control! This app requires the following environment variables to be set in .env or its equivalent:
  • CHANNEL_NAME
  • SLACK_BOT_TOKEN
  • SLACK_SIGNING_SECRET
  • PORT, if not using the default port specified in app.js

Running the app locally

• Configure your .env file or run the app with the above environment variables associated to your Slack app
• Set up an ngrok server to proxy requests to your local server.
  • Be sure to specify the port used by the Node app when starting ngrok, for example: ngrok http 3000
  • Add your local ngrok server URL to your slack app's Event Request URL in the format http://xyz.ngrok.io/slack/events

Tests

• Run npm start or npm run watch (using nodemon if installed) to run your app locally
• Run npm test to run tests once, or npm test:watch to keep test suite running and watching for changes

To Do

• Update documentation
• Replace sinon with Jest mocks 🙂
• Make input values more configurable