https://github.com/shyiko/hubot-starter-kit
Everything you need to get started with Hubot (Dockerfile included).
https://github.com/shyiko/hubot-starter-kit
Last synced: about 1 month ago
JSON representation
Everything you need to get started with Hubot (Dockerfile included).
- Host: GitHub
- URL: https://github.com/shyiko/hubot-starter-kit
- Owner: shyiko
- Created: 2015-06-21T00:06:16.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-07-09T00:49:43.000Z (almost 10 years ago)
- Last Synced: 2023-03-11T06:32:32.511Z (over 2 years ago)
- Language: CoffeeScript
- Homepage:
- Size: 133 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# hubot-starter-kit
Everything you need to get started with [Hubot](https://github.com/github/hubot).
> If you are new to Hubot - please read
[github/hubot/.../docs/scripting.md](https://github.com/github/hubot/blob/master/docs/scripting.md).
## What's included?
* Automated workflow (external-scripts.json regeneration on npm postinstall,
automatic reload on script changes, etc).
* Dockerfile which you can use to build your own custom Docker image (Dockerfile.ARMv7 for your Raspberry PI 2).
* [Skype](https://github.com/shyiko/hubot-skype-over-phantomjs)* / [HipChat](https://github.com/hipchat/hubot-hipchat) / [Slack](https://github.com/slackhq/hubot-slack) adapters.
* Redis brain.
> \* Depends on [PhantomJS](http://phantomjs.org/) being installed and
available on the PATH.
Add/remove stuff to suit your needs.
## Development
> PREREQUISITES: Git, Node, NPM. Also, if you don't have CoffeeScript installed - run `npm install -g coffee-script`.
```sh
git clone https://github.com/shyiko/hubot-starter-kit && cd hubot-starter-kit
npm install
npm run start-dev # try asking "hubot help"
```
> `npm run start-dev` loads shell adapter by default. If you want another
one (say HipChat) then `npm install hubot-hipchat --save && HUBOT_HIPCHAT_JID= HUBOT_HIPCHAT_PASSWORD= npm run start-dev -- --adapter hipchat`
## Building Docker image
```sh
docker build -t shyiko/hubot .
```
> ... or `docker build -f Dockerfile.ARMv7 -t shyiko/hubot .` for ARMv7.
## Deploying
```sh
docker run --name hubot-redis-brain -d redis:3.0.1 redis-server --appendonly yes # data volume - /data
docker run --name hubot --link hubot-redis-brain:redis \
-e REDIS_URL=redis://redis:6379/hubot \
-e HUBOT_SKYPE_USERNAME= \
-e HUBOT_SKYPE_PASSWORD= \
-d shyiko/hubot --adapter skype-over-phantomjs
```
> ... on ARMv7 replace `redis:3.0.1` with `shyiko/armv7-redis`.
> You can check Hubot logs with `docker logs -f hubot`.
## License
[MIT](https://github.com/shyiko/hubot-starter-kit/blob/master/mit.license)