HipChat Emotodex

Description

A simple application for viewing and searching all custom emoticons uploaded to DoSomething.org's HipChat group. This is a fork of the HipChat Emotodex hosted on Heroku.

Development

To run an Emotodex locally, you will need Ruby, Ruby Gems, Bundler and Redis installed on your system. Redis is an open source key-value store that is used by the HipChat Emotodex as a cache. Guard is used to run the RSpec test suite and compile SASS using Compass. Run guard to start watching for changes.

Once a local Emotodex is up and running you'll be able to push this repository up to Heroku. At the time of writing, both the hosting and Redis service are free. If you haven't used Heroku before, read through their quick start guide to get up and running.

To get started:

Visit the HipChat admin page for your group and upload some custom emoticons
Create a HipChat API key
Add the two environment variables required by the server to your .bash_profile:
- export HIPCHAT_API=<api_key> (your HipChat API key)
- export REDISTOGO_URL=redis://localhost:6379 (a Redis add-on for Heroku)
Clone this repository, cd into the HipChat Rolodex directory and run bundle install
rackup or to start the server!

Usage

Once you have the server running click on any emoticon to be prompted with its shortcut. You can also search for an emoticon and press enter to trigger the shortcut prompt. Note: this will only trigger once you are down to a single search result.

Author

M. Maxwell Watson

License

The MIT License (MIT)

Copyright (c) 2014 M. Maxwell Watson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

dosomething / hipchat-emotodex Goto Github PK