Home

The role of hummingbird is to connect to APIs of various services and provide a consistent stream of posts to be handled as necessary. This includes managing the various API connection policies, limits, etc. The idea is that hummingbird acts as a single, consistent stream of incoming data, regardless of where it comes from.

• Deployment
• API
• Architecture

Deployment

In order to run, hummingbird requires:

• node.js 0.10.x
• Redis 2.8.x

To deploy (assuming node.js is installed):

1. git clone git@github.com:chapmanu/hummingbird.git
2. Edit config.js and set the necessary API credentials and server information. You can edit environment-specific credentials in the various environment files. Settings in environment config files will override config.js when that environment is specified on run.
3. Run node app.js and then go get yourself a beer!

API

Hummingbird is manipulated strictly through a REST api, and each interaction must be defined by the service requesting a modification.

Services

• Twitter
• Facebook
• Instagram
• Wordpress

Interaction

Updating

• Accounts
• Keywords

Receiving

• Posts
• Updates
• Deletes

Architecture

Service Architecture