A simple feed reader for a single user
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
log
public
tests
tools
views
.gitignore
Gemfile
LICENSE
README.md
app.rb
config.ru
config.yaml
helpers.rb

README.md

Feeds

A simple feed reader for a single user

Setup

Setup MongoDB

Feeds uses MongoDB as datastore, so you need to setup MongoDB at first.

Setup Feeds

Feeds is a sinatra application and manages required gems by Gemfile, so you need to install Ruby (>= 1.9.3) and the bundler gem library.

Clone Feeds and exec bundle install to install required gems.

git clone https://github.com/tsujio/feeds.git
cd feeds
bundle install

Then run the tools/setup_db.rb script.

tools/setup_db.rb --server 127.0.0.1:27017 --database feeds

Configure config.yaml.

mongo:
  host: 127.0.0.1:27017
  database: feeds

Feeds authenticates a user by basic authentication. Set username and password by environment variables (admin:admin is used by default).

export FEEDS_AUTH_USERNAME=foo
export FEEDS_AUTH_PASSWORD=bar

Finally, launch Feeds by rackup.

rackup

You can register your favorite feed sources and subscribe them.

Thirdparty Libraries

Feeds uses protonet's jquery.inview library, and it is stored at public/js/jquery.inview.min.js.

This library realizes auto marking articles as read by scrolling.