an unclutered personal feedreader
Ruby HTML CSS JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
actions
lib
migrations
public
views
.gitignore
.ruby-version
Gemfile
Gemfile.lock
README.rdoc
config.ru
rakefile.rb
tidal.rb

README.rdoc

What ?

I've been fed up with bloglines bugs and don't like the cluttered interface of google reader so I decided to write my own feed readers.

Where ?

I have deployed it on my server at tidal.archiloque.net

How ?

Feedzirra does the heavy job of checking all the sites for new items.

Then I just have to store the data and display them, this is done in ruby using Sinatra and Sequel.

I'm using an ssl client certificate for authentication which requires some configuration on the frontal nginx / apache.

Design copiously inspired from Sam Ruby's excellent Planet Intertwingly.

Installation

Requirements: ruby and git

  1. checkout the code

  2. install the bundler gem if you don't have it ('gem install bundler')

  3. in the application directory run 'bundle install'

  4. add these variables to your environment or add them to the config.ru file using the ENV = 'XXX' syntax

  • HTTP_X_SSL_ISSUER the SSL issuer of your client certificate if you want to use authentification for the reader functionality

  • DATABASE_URL database url path, see here for details

  • TIMEZONE the name of the timezone to use for example 'Europe/Paris', see www.twinsun.com/tz/tz-link.htm

  1. in the app directory run 'rackup'

  2. go to localhost:9292

  3. cron a call to localhost:9292/fetch to fetch the feeds for updates

Pages

  • '/' a planet-like page presenting the lastest pages of your public feeds

  • '/reader' the reader page

  • '/admin' the administration page to add/edit/delete your feeds your feeds

  • '/fetch' fetch the feeds for updates

LICENSE:

Exept files with their own copyright license:

Copyright © 2010-2013, Julien Kirch All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of BiteScript nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.