Giter VIP home page Giter VIP logo

slack-office-dog-bot's Introduction

Frisket

The Office Dog Chat Bot

Frisket is a Slack chat bot that listens to your conversations on Slack and responds or reacts like a dog. If you mention certain words he'll get excited. He'll talk back or fetch. He even knows how to use emoticons!

This bot is free to run but comes with limitations. If you plan to use the free tier on Heroku, the bot will sleep after an hour unless you actively ping the server.

Frisket is based on Ein, which is a chat bot built off the [Hubot][hubot] framework intented to interact like a dog.

Getting Started

Dependencies

Installation

Download a copy of the project. Open a terminal and change directory to where you wish to store the project.

git clone https://github.com/grevory/slack-office-dog-bot.git
cd slack-office-dog-bot

Install the projects dependecies

npm install

Test that Hubot is functioning as expected

bin/hubot

If it worked you should see "slacky> [Date]". There may be some errors and warnings but they may not be of consequence. Feel free to play with Hubot here.

slacky> slacky help

Exit out of Hubot (CTRL / CMD + C)

Setup Server

If you are not already logged into Heroku on the command line

heroku login

Deploy the Bot

git add .
git commit -am "Initial commit"
heroku create --stack cedar
git push heroku master

This will return the domain of your bot as hosted on Heroku. You will need to use this URL to wake your bot.

Integrating the Bot with Slack

Login to Slack and got to https://slack.com/apps/build. Click on "Make a Custom Integration" and then "Bots".

Create a username for your bot. Might we recommend "@frisket"? Upload your photo. You can find one in this repo at ./frisket.png.

Copy the API Token and go back to your terminal window.

heroku config:set HUBOT_SLACK_TOKEN=xoxb-1234567890-XXXXXXXXXXXXXXXXXXX

Get the URL of your bot in case you forgot it.

heroku apps:info

To keep your bot from going to sleep

heroku addons:create scheduler:standard
heroku config:set HUBOT_HEROKU_KEEPALIVE_URL=xxx-yyyy.herokuapp.com
heroku addons:open scheduler

This will open a dashboard to manage the scheduling. For the command enter curl ${HUBOT_HEROKU_KEEPALIVE_URL}heroku/keepalive and set the reset of the inputs as you like.

Troubleshooting

Look at heroku logs or try running heroku restart.

If you run into any problems, checkout the Heroku docs or Hubot docs.

slack-office-dog-bot's People

Contributors

grevory avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.