Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zefer/trampled


https://github.com/zefer/trampled

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README

        

# Trampled

A simple app that sends email notifications when user(s) loose or gain Twitter followers.

## Usage

Run `rake tramp:notify` as a regular cron job, e.g. hourly follower checks.

## Setup

Requires a mongodb instance, and the following environment variables:

* `USERS` A list of users to be checked, and the email address to notify when that users' followers change. E.g. `USERS=bananaman:[email protected],dude:[email protected]`
* `RACK_ENV` Used by Mongoid to determine which connection (from mongoid.yml) to use. Even though this isn't a Rack app
* `EMAIL_FROM` From field for outgoing emails, e.g. `[email protected]` or `Tramp `
* `SMTP_HOST` Emails are sent via SMTP. You could use your Gmail account, or a service like SendGrid
* `SMTP_USERNAME`
* `SMTP_PASSWORD`
* `MONGODB_URL` When `RACK_ENV=production`, otherwise, localhost is used (see mongoid.yml)

## Simple deployment

This can easily be deployed to heroku, and run without cost using the Heroku Scheduler addon and a free MongoHQ instance.