readme.md

What is this?

Google reader is shutting down. A lot of people use it. A lot of apps depend on its API.
This project will be an attempt to create an API compatible replacement so those apps will continue to work by simply changing the API end point. I have no plans to build a frontend UI replacement, just the backend API.

Tech

• Node.js
• MongoDB (so I can try something new!)
• Express
• Mongoose

Some interesting modules to investigate:

• https://github.com/danmactough/node-feedparser
• https://github.com/dylang/node-rss

Some unofficial API documentation on the old Google Reader API that we'd be copying

• http://undoc.in
• http://ranchero.com/downloads/GoogleReaderAPI-2009.pdf
• http://code.google.com/p/pyrfeed/wiki/GoogleReaderAPI
• https://developers.google.com/accounts/docs/AuthForInstalledApps

Want to help?

Get in touch on Twitter or IRC (#reader on Freenode) and let me know! :) Feel free to fork this repository and send pull requests implementing features. Once you've sent a couple good ones, I'll add you as a contributor to the project to commit directly.

Things to work on:

• Feed fetching and storing
• API endpoints
• Testing
• etc. We are young!

Check out the issues for more details.

Installation

1. Install MongoDB if you haven't already.
2. Install Node.js if you haven't already.
3. Clone this repo using Git
4. Run npm install to install the dependencies