nanobox-io / nanobox-slackbot Goto Github PK

View Code? Open in Web Editor NEW

A very simple slackbot with one job... notify when someone joins a channel.

License: Mozilla Public License 2.0

JavaScript 100.00%

nanobox-slackbot's Introduction

Nanobox Slackbot (nanobot)

Nanobot is a very simple Slack bot with one purpose (atm). Notify users when someone joins a channel.

HEADS UP - A Slack bot must be invited (/invite @bot_name) to a channel before it can listen for events in that channel.

Environment Variables

Nanobot makes use of two environment variables:

# This is your Slack bot api token.
BOT_API_TOKEN=slackbot-api-token

# This is a space delimited list of channels|groups|usernames/id's
# which will get notified when someone joins the channel.
SUBSCRIBERS=@username #channel etc.

Run the app

# clone the code
git clone https://github.com/nanobox-io/nanobox-slackbot.git

# cd into the app
cd nanobox-slackbot

Locally

# add your slack bot api token
nanobox add evar local BOT_API_TOKEN=slackbot-api-token

# add your notify users
nanobox add evar local SUBSCRIBERS=@username #channel etc.

# run the app
nanobox run node index.js

In Production

To run nanobot in production follow the guides on <a href="http://guides.nanobox.io/nodejs/generic/launch-your-app/", target="_blank">launching a nodejs app with nanobox.

HEADS UP - Make sure you <a href="http://guides.nanobox.io/nodejs/generic/production-evars/", target="_blank">add the environment variables from above via your dashboard.

nanobox-slackbot's People