paulkinlan / ioreader Goto Github PK

View Code? Open in Web Editor NEW

59.0 4.0 6.0 1.34 MB

IO Reader - a news reading framework to enable you to target one news app to multiple devices.

Home Page: http://io-reader.com

License: Apache License 2.0

Shell 0.03% JavaScript 99.97%

ioreader's Introduction

io-reader server

This is a basic proxying server that has some state.

The server runs an instance of the configuration document, which includes the type of API proxy to use and the categories to display.

There are two API proxies included:

Guardian
NPR

Installation

Now you can install the dependencies:

npm install express mustache async less uglify-js

Running the app

./run.sh <CONFIG_NAME>

Where <CONFIG_NAME> is the name of a folder in <PROJECT_ROOT>/config.

Configuring your app

Each application needs a configuration to run, the configuration defines properties such as:

The port and hostname for the application to listen on.
The name and description of the application
The directory where the client code is (it can be anywhere you want)
The API proxy to use (Guardian, NPR, GoogleFeedApi etc)
1. The parameters for the API, such as API Keys
The columns to display in the app
1. And proxy specific parameters

Example Configuration: Google Feed API

exports.config = { 
    id: "googlefeed",
    name: "Chrome Developer Relations",
    description: "All the latest news from around the Chrome team",
    version: "0.0.0.11",
    baseDir: "server/templates/",
    clientDir: "client/",
    categories: [
        { 
            id: "pk", url : "http://paul.kinlan.me/rss.xml", title: "Paul Kinlan"
        },
        { 
            id: "mm", url : "http://softwareas.com/rss.xml", title: "Mike Mahemoff"
        }, 
        {
            id: "ig", url : "http://greenido.wordpress.com/rss.xml", title : "Ido Green"
        },
        {
            id: "smus", url : "http://smus.com/rss.xml", title : "Boris Smus"
        }
    ],
    options: {
        appCache: "",
        port: 3000,
        proxies: {
            "googlefeed": {
                referer: "http://paul.kinlan.me/"
            }
        }
    }
};

Most of it is pretty self explanatory, the categories array is specific to the provider. The Guardian API proxy is a simple collection of category names. The NPR API proxy is a collection of category numbers.

For a given proxy, there might require some specific parameters such as API Keys.

ioreader's People

Contributors

Stargazers

Watchers

Forkers

printminion myusernamejeep srinivasarao549 terjeknuts cchery101

ioreader's Issues

Uncaught Exception on startup

When visiting the page, with FireBug running, I regularly see this message appear in the console:

uncaught exception: [Exception... "Not enough arguments" nsresult: "0x80570001 (NS_ERROR_XPC_NOT_ENOUGH_ARGS)" location: "JS frame :: http://io-reader.com/scripts/desktop/controller.js :: <TOP_LEVEL> :: line 37" data: no]

Proxy fails due to restrictions on show-media

Fix the guardian API so that it still works when the licence key isn't allowed to use larger media assets.

Create an RSS proxy

It would be excellent if we could parse/configure RSS feeds so that people can quickly build their own apps.

Null Reference Exception on Google Feed Proxy

The GoogleFeed Proxy doesn't use images

Images are available in the feed but not used. Use them.

Switching from Desktop to Tablet with story open

See screenshot:

There are other cases where this happens, but it seems to be consistent in the above case. I'll see if I can reproduce the others with a script to see if it's a timing thing.