illuminerdi / wrimostats Goto Github PK

= wrimostats

* http://wrimostats.com
* http://github.com/illuminerdi/wrimostats/tree/master
* http://www.nanowrimo.org

== DESCRIPTION:

This Rails application will allow a user to create an account, associate it with a Nanowrimo User ID, and customize their own stats dashboard, create wordwars, and generate charts and graphs on the fly.

== FEATURES/PROBLEMS:

Features:
* None yet, but uses the illuminerdi-nanowrimo gem to easily pull data out of the Nanowrimo WCAPI
* Create a user account that allows you to customize your WC statistics, or those for your Region, Genre, or the entire Nanowrimo program.
* Generate dynamic and on-the-fly flash-based graphs using the FusionCharts package.
* Create a word war, where your running stats and those of chosen 'writing buddies' are compared in charts and graphs. Will have a higher upper-bound for number of buddies than the Nanowrimo site official widgets allow.

Problems:
* Well, it needs to be created.
* Man, it might be nice if there's a FusionCharts Ruby gem already with Rails hooks. I'd probably have to make one. Dammit.

== SYNOPSIS:

It's a rails app. Hopefully there will be nothing special required to get it running. It should run on some awesome host with Passenger support - I'll figure that out when November gets closer.

== REQUIREMENTS:

* ruby 1.8.6
* rails 2.3.2
* illuminerdi-nanowrimo 0.7.5

TEST:
* thoughtbot-shoulda 2.10.1
* fakeweb 1.2.2

== INSTALL:

clone this repo, then be railsy:
$ rake db:create
$ rake db:migrate
$ ruby script/server

== LICENSE:

(The MIT License)

Copyright (c) 2009 Joshua Clingenpeel

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.