Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fcapovilla/caporss
A simple web RSS reader
https://github.com/fcapovilla/caporss
Last synced: 16 days ago
JSON representation
A simple web RSS reader
- Host: GitHub
- URL: https://github.com/fcapovilla/caporss
- Owner: fcapovilla
- License: bsd-3-clause
- Created: 2013-03-30T19:42:01.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-03-06T21:51:58.000Z (over 8 years ago)
- Last Synced: 2024-08-01T00:57:06.355Z (3 months ago)
- Language: JavaScript
- Size: 4.12 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.textile
- License: LICENSE
Awesome Lists containing this project
README
# CapoRSS
Version 1.3.0
[](https://travis-ci.org/fcapovilla/caporss)
[](https://coveralls.io/r/fcapovilla/caporss?branch=master)
[](https://gemnasium.com/fcapovilla/caporss)
[](https://heroku.com/deploy)
## Description
CapoRSS is a simple self-hosted RSS aggregator written in Ruby and Javascript.
## Features
* Live notifications using [Server-Sent Events](http://www.w3.org/TR/eventsource).
* [Pubsubhubbub (Push)](https://code.google.com/p/pubsubhubbub/) 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](https://en.wikipedia.org/wiki/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
* [Desktop view](doc/screenshots/screenshot.png)
* [Mobile view](doc/screenshots/mobile.png)
## Installation
This procedure will run CapoRSS in development mode using an SQLite database. Other installation methods can be found in the [installation](doc/install.textile) 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
* [Installation](doc/install.textile)
* [Development](doc/development.textile)
* User documentation :
* [English version](doc/en.textile)
* [French version](doc/fr.textile)
* [Changelog / Release notes](CHANGELOG.textile)
## Acknowledgment
CapoRSS is built on top of these great projects :
* [Ruby](http://www.ruby-lang.org/)
* [Sinatra](http://www.sinatrarb.com/)
* [Datamapper](http://datamapper.org/)
* [Feedjira](http://feedjira.com/)
* [Nokogiri](http://nokogiri.org/)
* [R18n](https://github.com/ai/r18n)
* [Bootstrap](http://twitter.github.com/bootstrap/)
* [bootstrap3-typeahead](https://github.com/bassjobsen/Bootstrap-3-Typeahead)
* [Font awesome](http://fortawesome.github.com/Font-Awesome/)
* [PNotify](https://github.com/sciactive/pnotify)
* [Backbone.js](http://backbonejs.org/)
* [Marionette.js](http://marionettejs.com/)
* [Lo-Dash](http://lodash.com/)
* [JQuery](http://jquery.com/)
* [JQuery-cookie](https://github.com/carhartl/jquery-cookie)
* [Haml](http://haml.info/)
* [Sass](http://sass-lang.com/)
* [Thin](http://code.macournoyer.com/thin/)
* [rack-ssl-enforcer](https://github.com/tobmatth/rack-ssl-enforcer)
* [sinatra-flash](https://github.com/SFEley/sinatra-flash)
* [Bower](http://bower.io/)
* [Grunt](http://gruntjs.com/)
Also, CapoRSS's favicon is from the [RRZE Icon Set](http://rrze-icon-set.berlios.de/)
## TODO
* Optimisations, performance improvements and bugfixes