npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hubot-hall

v1.0.3

Published

A Hall adapter for hubot

Downloads

9

Readme

hubot-hall

A Hubot adapter for Hall

Compatibility with Hubot

  • Hubot >= 2.4.2

Compatibility with NodeJS

  • Preferably use NodeJS 0.8.x or later

Installing Hubot-Hall on Heroku

  1. Complete the instructions in the Hubot wiki and return to these steps to configure your app for Hall.

  2. Create a new Hall account for your bot to use.

  • You can set the first name and last name on the account to whatever you wish.
  • Once setup is complete, you can invoke your bot with either the full name of the user account or with the name you give the bot when you start it up.
  • Record the email address and password so you can configure your Hubot-Hall adapter later.
  1. The hubot/ directory that you created in the Hubot on Heroku instructions above is all that is relevant to us now. Let's switch to it:

     % cd hubot/
  2. Edit package.json and add hubot-hall to the dependencies section. It should look something like this:

     "dependencies": {
       "hubot-hall": "latest",
       ...
     }
  3. If you won't be using the redis-brain.coffee script, you need to remove it from the array in hubot-scripts.json file.

  4. Edit Procfile and change it to use the hall adapter and give it a name (optional) where bot_name is the name you'll use to invoke the bot (it will default to hubot):

     web: bin/hubot -a hall -n bot_name
  5. Configure it:

    You will need to set a configuration variable if you are hosting on the free Heroku plan (if you haven't already done so).

     % heroku config:add HEROKU_URL=http://soothing-mists-4567.herokuapp.com

    Where the URL is your Heroku app's URL (shown after running heroku create, or heroku rename).

    Set the email to the email you used to register the bot with Hall:

     % heroku config:add HUBOT_HALL_EMAIL="..."

    Set the password to the password chosen when you created the bot's account.

     % heroku config:add HUBOT_HALL_PASSWORD="..."
    	
  6. Add and commit your package.json changes:

     % git add .
     % git commit -m "added the hubot-hall dependency"
  7. Deploy and start the bot:

     % git push heroku master
     % heroku ps:scale web=1

    This will tell Heroku to run 1 of the web process type which is described in the Procfile.

  8. You should see the bot join all rooms it has been added to. If not, check the output of heroku logs. You can also use heroku config to check the config vars and heroku restart to restart the bot. heroku ps will show you its current process state.

  9. Assuming your bot's name is "Hubot", the bot will respond to commands like "@hubot help". The '@' symbol is optional.

  10. To configure the commands the bot responds to, you'll need to edit the hubot-scripts.json file (valid script names here) or add scripts to the scripts/ directory.

  11. To deploy an updated version of the bot, simply commit your changes and run git push heroku master again.

Running on Unix

  1. Complete the instructions in the Hubot wiki and return to these steps to configure your app for Hall.

  2. Create a new Hall account for your bot to use.

  • You can set the first name and last name on the account to whatever you wish.
  • Once setup is complete, you can invoke your bot with either the full name of the user account or with the name you give the bot when you start it up.
  • Record the email address and password so you can configure your Hubot-Hall adapter later.
  1. The hubot/ directory that you created in the Hubot on Unix instructions above is all that is relevant to us now. Let's switch to it:

     % cd hubot/
  2. Edit package.json and add hubot-hall to the dependencies section. It should look something like this:

     "dependencies": {
       "hubot-hall": "latest",
       ...
     }
  3. Install the dependencies

     % npm install
  4. Configure it:

    Set the email to the email you used to register the bot with Hall:

     % heroku config:add HUBOT_HALL_EMAIL="..."

    Set the password to the password chosen when you created the bot's account.

     % heroku config:add HUBOT_HALL_PASSWORD="..."
  5. Run the hubot with the Hall adapter

     % bin/hubot -a hall
  6. Or run hubot from a script like so:

#!/bin/bash

export HUBOT_HALL_EMAIL="..."
export HUBOT_HALL_PASSWORD="..."

bin/hubot --a hall