Code Monkey home page Code Monkey logo

hubot-irc's Introduction

Hubot IRC Adapter

Description

This is the IRC adapter for hubot. For discussion about this adapter, join #hubot-irc on irc.freenode.net.

Installation and Setup

NOTICE: This bot is now upgraded to Hubot 2.3. You should specify 0.0.8 as your hubot-irc dependency for older versions of Hubot (<2.3.0).

  • Download and Extract Hubot 2.3 from the Hubot Downloads page
  • Run npm install hubot-irc --save in the extracted Hubot 2 directory to add the hubot-irc adapter to your dependencies.
  • Install dependencies with npm install
  • Set your environment variables like: (Windows Users substitute set for export)
    • export HUBOT_IRC_NICK="hubot-new"
    • export HUBOT_IRC_ROOMS="#hubot-irc"
    • export HUBOT_IRC_SERVER="irc.freenode.net"
  • Run hubot with bin/hubot -a irc

Usage

You will need to set some environment variables to use this adapter.

Heroku

% heroku config:add HUBOT_IRC_NICK="hubot"
% heroku config:add HUBOT_IRC_ROOMS="#hubot,#hubot-irc"
% heroku config:add HUBOT_IRC_SERVER="irc.freenode.net"

Non-Heroku environment variables

% export HUBOT_IRC_NICK="hubot"
% export HUBOT_IRC_ROOMS="#hubot,#hubot-irc"
% export HUBOT_IRC_SERVER="irc.freenode.net"

Testing Local Changes

gem install foreman
git clone https://github.com/github/hubot.git
cd hubot
# this next line makes a deployable version of the bot for heroku or local deployments
make package 
mv hubot/ ../testbot
cd ../testbot
- modify package.json to include the version of hubot-irc to test with either an official release or from your local repo
    for an example see this https://gist.github.com/3148311
- modify Procfile, change adapter (-a option) to "irc" and change the name (-n option) of the bot
- make sure you followed the usage section from above to set the environment variables (Non-Heroku section)
foreman start

...and that is it

Contribute

Here's the most direct way to get your work merged into the project.

  1. Fork the project
  2. Clone down your fork
  3. Create a feature branch
  4. Hack away and add tests, not necessarily in that order
  5. Make sure everything still passes by running tests
  6. If necessary, rebase your commits into logical chunks without errors
  7. Push the branch up to your fork
  8. Send a pull request for your branch

Copyright

Copyright © Fernando Ortiz. MIT License; see LICENSE for further details.

hubot-irc's People

Contributors

jgable avatar nandub avatar elliotttf avatar tombell avatar fabianfrank avatar jamesob avatar pboos avatar kmnk avatar botdev avatar mrtazz avatar getfatday avatar doitian avatar johnmichel avatar saebekassebil avatar smgt avatar

Watchers

Makara Wang avatar kuno avatar YukiGu avatar Quentin Berder avatar  avatar Vincent Viallet avatar Zhou Honglin avatar Marcio avatar Stelios avatar James Cloos avatar Juha avatar haishan avatar Fraser Xu avatar Fred Wang avatar  avatar Frank Dou avatar Manuel Villing avatar Aleksi Pekkala avatar 孙松 avatar Chopper Lee avatar Xavier Zhou avatar Baruch Berger avatar Benjamin avatar Jamie Stobbs avatar QingFeng avatar Kate Wu avatar meggery avatar  avatar Wang Zixiao avatar Charlie Li avatar Ray Wang avatar Kaleo avatar Lennon Cheng avatar Jack Z avatar mikelhsia avatar JohnnyGu avatar David Guan avatar Vera avatar John Roberts avatar Mary avatar Leo Zhou avatar  avatar  avatar Iris avatar Hazel Yang avatar Jonathan avatar Peter Pierzchanowski avatar Coco avatar JasonWang avatar VincentXiang avatar natalia 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.