aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRhenium <rhenium@rhe.jp>2014-01-17 22:39:07 +0900
committerRhenium <rhenium@rhe.jp>2014-01-17 22:39:07 +0900
commit54b7342cb8ffb385a750d7ed3020c79af7faf84c (patch)
tree0fd3c2c0202b0765e25475abb6e68ce0d7231f02 /README.md
parente1f1602ef0153dbee997c9fcef6ef6f8c8291cc5 (diff)
downloadaclog-54b7342cb8ffb385a750d7ed3020c79af7faf84c.tar.gz
update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md77
1 files changed, 43 insertions, 34 deletions
diff --git a/README.md b/README.md
index e6b13b9..71690f9 100644
--- a/README.md
+++ b/README.md
@@ -1,79 +1,88 @@
# Aclog [![Build Status](https://travis-ci.org/rhenium/aclog.png?branch=master)](https://travis-ci.org/rhenium/aclog) [![Coverage Status](https://coveralls.io/repos/rhenium/aclog/badge.png)](https://coveralls.io/r/rhenium/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)
+* powered by Ruby on Rails
+* completely free and open source (The 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
+* Collecting favorites and retweets from Twitter Streaming API
* Protected account support
-* JSON API
-* RSS
+* JSON API (OAuth Echo)
+* Atom feed
### Not yet / will be implemented
* New UI
-* User settings (favorites notification)
+* Import tweets from Favstar / Favotter / tweets.zip / ..
## Requirements
-* Ruby 2.0.0/1.9.3
-* MySQL/MariaDB 5.5.14+ (must support utf8mb4)
+* Ruby 2.1.0/2.0.0
+* MySQL/MariaDB 5.5.14+ (needs utf8mb4 support)
-## Setup
-### MySQL
+## Installation
+### Database
* Create MySQL user
-### aclog configuration (application)
-* Install packages
+### Aclog (Application Server)
+* Clone the source
- $ bundle install
+ $ # We'll install aclog into /var/webapps/aclog
+ $ cd /var/webapps
+ $ git clone https://github.com/rhenium/aclog.git
+ $ cd /var/webapps/aclog
-* Set consumer keys, base URL, ..
+* Configure it
+ $ # Copy the example aclog config
$ cp config/settings.yml.example config/settings.yml
+ $ # Edit it
$ vi config/settings.yml
-* Setup database
-
+ $ # Copy the example aclog database config
$ cp config/database.yml.example config/database.yml
$ vi config/database.yml
- $ rake db:setup
-
-* Set secret token
+ $ # Set random 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
+ $ # Setup database. This will create database and tables on MySQL server.
+ $ rake db:setup
- $ ./start_receiver.sh start
- $ ./start_unicorn start
+* Install Gems
-### aclog configuration (worker)
-* In collector/
+ $ bundle install
- $ cd collector
+* Start your aclog
-* Install packages
+ $ # Start Unicorn (Web server)
+ $ ./start_unicorn.sh start
+ $ # Start Background server
+ $ ./start_receiver.sh start
- $ bundle install
+### Aclog (Collector Clusters)
+* Chdir
+
+ $ cd /var/webapps/collector
-* Set consumer keys, secret key
+* Configure it
+ $ # Copy the example collector config
$ cp settings.yml.example settings.yml
+ $ # Edit it
$ vi settings.yml
-* Start
+* Install Gems
+
+ $ bundle install
+
+* Start collector
- $ RAILS_ENV=production ./start.sh
+ $ RAILS_ENV=production bundle exec ./start.rb
## Contributing