paper-gamification-website
==================

Visualization of the statistics generated by the python script in my other repository: [paper-gamification](https://github.com/Kadrian/paper-gamification).

Currently, this rails app is configured to be deployed on Heroku. Hopefully, I can soon provide setup instructions, so you guys can gamifiy your paper writing experiences too ;-)

Stay tuned!
paper-gamification-website
==================

Gamifiy your paper writing experiences!

This is a visualization website of the statistics generated by the python script in my other repository: [paper-gamification](https://github.com/Kadrian/paper-gamification).

Visualization is done with the help of HTML `<canvas>` and several [Processing.js](http://processingjs.org/) scripts.

## Installation

1) Deployment

Basically, it should be possible to deploy this app anywhere. At the moment, I use Heroku for that.
So you can clone this repository, register on [Heroku](https://www.heroku.com/) and follow their instructions on how to deploy a rails app.

2) Setup

* Create and migrate the database
* Insert at least one paper. For example via rails console on Heroku: 

    heroku run rails console

    Paper.create :title => "The Flux-Compensator"

* Use that so-created paper ID when starting the [paper-gamification](https://github.com/Kadrian/paper-gamification) python script.

## Contribution

Plese feel free to contribute! I'm rather new to open source publishing ;)

Update Readme with install instructions
Update Readme with install instructions
