Hubot

Hubot is a chat bot built on the [Hubot][hubot] framework. It was initially generated by [generator-hubot][generator-hubot], and configured to be deployed on [Heroku][heroku] to get you up and running as quick as possible.

Requirements

node.js
npm

Installation

Install Node.js

Download the appropriate binary for your OS and install
Install NPM (Which comes already with Node)
If using Homebrew then:
```
 brew install node npm
```
Install NPM dependencies
```
 npm install
```

Running Hubot Locally

You can test your hubot by running the following.

You can start Hubot locally by running:

% bin/hubot

You'll see some start up output about where your scripts come from and a prompt:

[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading adapter shell
[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading scripts from /home/tomb/Development/hubot/scripts
[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading scripts from /home/tomb/Development/hubot/src/scripts
Hubot>

Then you can interact with Hubot by typing Hubot help.

Hubot> Hubot help

Hubot> animate me <query> - The same thing as `image me`, except adds a few
convert me <expression> to <units> - Convert expression to given units.
help - Displays all of the help commands that Hubot knows about.
...

Testing

npm test will run all tests.

hubot-scripts

There will inevitably be functionality that everyone will want. Instead of writing it yourself, you can check hubot-scripts for existing scripts.

To enable scripts from the hubot-scripts package, add the script name with extension as a double quoted string to the hubot-scripts.json file in this repo.

external-scripts

Hubot is able to load scripts from third-party npm package. Check the package's documentation, but in general it is:

Add the packages as dependencies into your package.json
npm install to make sure those packages are installed
Add the package name to external-scripts.json as a double quoted string

You can review external-scripts.json to see what is included by default.

Deployment

Hubot is automatically deployed by Heroku when any changes are made to the master branch.

emmaviolet/uatbot