Skip to content
Twailer will send you email updates whenever a new tweet containing a particular hashtag or mention is published
JavaScript PHP
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
test
.gitignore
.travis.yml
LICENSE
README.md
config.js
package.json

README.md

Twailer v1.0.0 Build Status

Twailer is a little robot that monitors certain channels on Social Media. It can send you realtime notifications whenever somebody tweets with a certain hashtag/mention.

What's new in version 1?

After 9 months of prototype evaluation, it is time for a complete rewrite. The previous version (v0) was a bugged, quick and dirty prototype. The next version (v1) focusses on stability and modularity which will allow users to track more social media.

Pluggable Architecture

Basically, Twailer handles three types of tasks:

  • Social media monitoring (SourceMonitor)
  • Subscription management (SubscriptionStore)
  • Sending notifications (NotificationHandler)

Each of these tasks is replaceable with a custom implementation in order to suit your needs.

                                          +-----------------------+
                                          |                       |
                                          |     SourceMonitor     |
                                          |                       |
                                          +-----------------------+
                                                    ^   |
                                  channels to track |   | posts
                                                    |   v
+-----------------------+                 +-----------------------+                +----------------------+
|                       |  (un)subscribe  |                       |  notification  |                      |
|     TwailerClient     |     request     |        Twailer        |    commands    |  NotificationSender  |
|                       | --------------> |                       | -------------> |                      |
+-----------------------+                 +-----------------------+                +----------------------+
                                                    ^   |
                                       subscription |   | subscription
                                                    |   v
                                          +-----------------------+
                                          |                       |
                                          |   SubscriptionStore   |
                                          |                       |
                                          +-----------------------+

Work In Progress

  • Use Unix sockets instead of Redis Pub/Sub
  • SourceMonitors
    • TwitterMonitor
    • ...
  • SubscriptionStores
    • InMemorySubscriptionStore
    • MongoSubscriptionStore
    • ...
  • NotificationSenders
    • EmailSender
    • ...

Issues

Create a new ticket on GitHub.

Something went wrong with that request. Please try again.