Corresponding rails website to render the stats calculated by the python script at "paper-gamification"
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
test
vendor/assets
.gitignore
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
config.ru
preview.jpg

README.md

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. The main part of the visualization is done with the help of HTML <canvas> and several Processing.js scripts.

Preview Screenshot

Installation

1) Deployment

Change credentials in `author.yml

At the moment, I use Heroku for deployment, but you should be able to deploy this app anywhere. For Heroku: clone this repository, register on Heroku 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"

[OPTIONAL] If you want to receive emails when someone cheers you up:

  • [OPTIONAL] Add Postmark for sending emails on Heroku heroku addons:docs postmark

  • [OPTIONAL] Configure Postmark to use your email settings heroku addons:open postmark

  • [OPTIONAL] If you want to use postmark locally as well: you have to set environment variables. To do this automatically, you can use foreman. Create a file with your settings: bash -c 'echo "POSTMARK_API_KEY=heroku config:get POSTMARK_API_KEY" >> .env' bash -c 'echo "POSTMARK_SMTP_SERVER=heroku config:get POSTMARK_SMTP_SERVER" >> .env' bash -c 'echo "POSTMARK_INBOUND_ADDRESS=heroku config:get POSTMARK_INBOUND_ADDRESS" >> .env' and start your rails instance with foreman start

Contribution

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