Skip to content

fcapovilla/caporss

Repository files navigation

CapoRSS

Version 1.3.0

Build Status Coverage Status Dependency Status

Deploy

Description

CapoRSS is a simple self-hosted RSS aggregator written in Ruby and Javascript.

Features

  • Live notifications using Server-Sent Events.
  • Pubsubhubbub (Push) support for live feed updates.
  • Mobile device support using responsive HTML.
  • Feed organization using folders with drag-and-drop support.
  • Import and export feeds in OPML format.
  • Import favorites in JSON format (GReader-compatible). Export favorites in JSON and HTML format.
  • Sync your feeds with mobile applications compatible with the Google Reader API.

Screenshots

Installation

This procedure will run CapoRSS in development mode using an SQLite database. Other installation methods can be found in the installation documentation file.

  1. Install Ruby 2.1.0

  2. Install the "bundler" Ruby gem using this command:

     gem install bundler
    
  3. Clone CapoRSS :

     git clone https://github.com/fcapovilla/caporss.git
    
  4. Run a "bundle install" in the application's root directory. Note that some dependencies are native extensions, so you may need to install a compiler and development packages:

     bundle install --without production test travis
    
  5. Start CapoRSS using this command:

     bundle exec ruby app.rb
    
  6. Open a web browser and go to "http://localhost:4567"

  7. The default username/password is "admin"/"admin"

Documentation

Acknowledgment

CapoRSS is built on top of these great projects :

Also, CapoRSS's favicon is from the RRZE Icon Set

TODO

  • Optimisations, performance improvements and bugfixes