A webapp to track favorites on Twitter
Ruby Vue CSS JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
collector
config config/settings.yml.example: add comments Jan 22, 2016
db
devtools
example
frontend
lib
log
spec
vendor
worker_node
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
Guardfile
INSTALL.md
LICENSE.txt
Procfile
README.md
Rakefile
config.ru

README.md

Aclog Build Status Coverage Status

is a web application that tracks users' retweeting and favoriting on Twitter in real-time.

  • is powered by Ruby, EventMachine, Ruby on Rails and Vue.js
  • is completely free and open source (The MIT License)
  • has scalable structure: capable of handling over 6k users = 6k simultaneous UserStream connections.

Status

Features

  • Collecting likes and retweets via Twitter Streaming API
  • Protected accounts support
  • JSON API (with OAuth Echo)
  • Atom feed

Requirements

  • Linux (WorkerNode optionally needs epoll)
  • Ruby 2.3.0
  • MySQL/MariaDB >= 5.5.14 (utf8mb4 support is required)
  • memcached
  • Node.js >= 4.0

Installation

Aclog has 3 components:

  • / - application backend (Rails, requires MySQL and memcached)
  • /frontend - client side code (Node.js)
  • /worker_node - event collecter node (plain Ruby, requires memcached)

So, there are some files you have to configure:

  • /config/settings.yml - Main configuration
  • /config/database.yml - Database user / password
  • /config/secrets.yml - Rails's secret_key_base
  • /frontend/settings.js - Frontend configuration
  • /worker_node/settings.yml - WorkerNode configuration

For production, read INSTALL.md for details.
For development, you can run aclog on your machine with foreman, after configuration.

cd /path/to/aclog
bundle install
bundle exec rake db:setup

cd worker_node && bundle install && cd ..
cd frontend && npm install && cd ..

foreman run
# will run all components in foreground (this currently listens tcp/3000 (backend), tcp/3001 (frontend), tcp/3002 (reverse proxy)
# you will be able to access your aclog at http://localhost:8001/

Special Thanks

License

MIT License. See the LICENSE file for details.