README.md

muse

A Slackbot to promote self-regulated learning and metacognitive reflection. Powered by Botkit and the Slack API. To get started, run npm install and npm start to get the bot running. If you're running the app locally, use ngrok or localtunnel for the buttons to work. You must set up a webhook for button payloads through Slack.

Slackbot interface

Reflection Dashboard

If you are a member of the DTR Slack, you can view your reflection dashboard at https://muse-delta.herokuapp.com.

Setup

If you're running locally, uncomment lines 1 and 4-7 in bot.js. Also uncomment lines 13-16 in components/express_webserver.js. Make sure your .env file contains the following variables:

botToken
oAuthToken
PORT
clientId
clientSecret
clientSigningSecret
MONGO_URI
botId
botName

You must obtain authorization tokens through Slack. To enable interactive components, you must set up a webhook through Slack (instructions can be found here).

If you are having issues setting up your app through Slack, this is a great tutorial to follow.

Deploying to Heroku

When deploying to Heroku, comment out all instances of the following code:

var env = require('node-env-file');
env(__dirname + '/.env');
if (!process.env.clientId || !process.env.clientSecret || !process.env.PORT) {
   usage_tip();
}

Uncomment the above lines for local development.