A tool for visualizing your pocket reading data.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
test
.bowerrc
.editorconfig
.gitattributes
.gitignore
.jshintrc
.yo-rc.json
CREDITS.md
Gruntfile.js
LICENSE
README.md
ReadFlows.png
bower.json
package.json

README.md

ReadFlows

A tool for visualizing reading data fron a user's Pocket app.

Screenshot

Demo

Use a demo at http://play.fm.to.it/ReadFlows

Installation

The visualization runs entirely in the client browser. However the Pocket API does not support CORS which means that it cannot be queried directly from Javascript. Therefore there is PHP proxy to handle these requests.

If you want to install this on your own server you will need a web host with PHP.

To build the frontend you'll also need Grunt and Bower installed.

Get the source

Download the source from the link on the right or git clone it to your computer.

git clone https://github.com/mjs2020/ReadFlows

Get the dependencies

Install the node modue dependencies

npm install
bower install

Configure

You will need to create an app in Pocket to get an API key and run this on your own server.

  1. Log in to pocket: http://getpocket.com/login
  2. Go to http://getpocket.com/developer/apps/new create an app. The app needs "retrieve" permission.
  3. Get the consumer key for your new app.
  4. Edit the file app/config.php in your favourite text editor, add the consumer key and the URL to the callback.html file on your own server.

Build

To build the app run:

grunt build

It will create a dist subfolder.

Deploy

Upload the contents of the dist folder to your server and access it through your browser.

Licence

ReadFlows is free software licenced under the GNU GPL licence.

Credits

Checkout the CREDITS.md file