aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 6dc135d46aa9a3bc8803ed1cd33287a56fb730f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Aclog
Collects favs and retweets in real time by UserStreams.
A web service like Favstar.

## Aclog is
* Powered by Ruby on Rails
* Free and open source (MIT License)

## Status
* *unstable*
* Working on [aclog.koba789.com](http://aclog.koba789.com)

## Features
* Register with a Twitter account
* Collect favorites and retweets by UserStreams
* List user's best/newest favorited or retweeted tweets
* Show how many favorited/retweeted by specified user
* Protected account support
* JSON API

### Not yet / will be implemented
* New UI
* User settings (favorites notification)

## Requirements
* Ruby 1.9.3
* MySQL/MariaDB 5.5.14+

## Setup
### MySQL
* Add to `my.cnf`

    ```ini
    [mysqld]
    innodb_file_format = Barracuda
    innodb_file_per_table = 1
    innodb_large_prefix
    ```

* Create MySQL user

### aclog configuration (application)
* Install packages

        $ bundle install

* Set consumer keys, base URL, ..

        $ cp config/settings.yml.example config/settings.yml
        $ vi config/settings.yml

* Setup database

        $ cp config/database.yml.example config/database.yml
        $ vi config/database.yml
        $ rake db:setup

* Set secret token

        $ cp config/initializers/secret_token.rb.example config/initializers/secret_token.rb
        $ sed -i s/replace_here/$(rake secret)/g config/initializers/secret_token.rb

* Start

        $ ./start.sh start receiver
        $ ./start.sh start unicorn

### aclog configuration (worker)
* In collector/

        $ cd collector

* Install packages

        $ bundle install

* Set consumer keys, secret key

        $ cp settings.yml.example settings.yml
        $ vi settings.yml

* Start

        $ RAILS_ENV=production ./start.sh


## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request