Skip to content

kaitafj/yamada-bot

 
 

Repository files navigation

yamada-bot

Build Status Code Climate

yamada-bot is a chat bot built on the Hubot framework. It was initially generated by generator-hubot.

Running yamada-bot Locally

You can test yamada-bot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

Before starting yamada-bot, you need install nodejs, npm and redis You can install them on MacOSX:

$ brew install nodejs
$ brew install npm
$ brew install redis

Now you can start yamada-bot locally by running:

$ git clone https://github.com/noralife/yamada-bot.git
$ cd yamada-bot
$ bin/hubot

You'll see some start up output and a prompt:

[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
yamada-bot>

Then you can interact with yamada-bot by typing yamada-bot help.

yamada-bot> yamada-bot help
...

Deploying to Linux

You also need nodejs, npm and redis for your Linux. Then, you can deploy yamada-bot to Linux.

$ cd ~/yamada-bot
$ git pull origin master
$ forever stop 0
$ ./yamada-bot.sh

yamada-bot.sh is not included in this repo for security reason. The script is simple and should include :

$ cat yamada-bot.sh
#!/bin/sh

set -e

npm install

export PATH="node_modules/.bin:node_modules/hubot/node_modules/.bin:$PATH"
export HUBOT_SLACK_TOKEN=<TOKEN_ON_SLACK_INTEGRATION_PAGE>
export METADATA_API_KEY=<METADATA_API_KEY>

if forever list | grep slack
then
  forever stop 0
fi

forever start -c coffee node_modules/.bin/hubot --name "yamada-bot" --adapter slack

License

Please refer to LICENSE.md

Contributing

  1. Fork it ( https://github.com/noralife/yamada-bot )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CoffeeScript 98.0%
  • Shell 1.4%
  • Batchfile 0.6%