alexbaumhoer / wtfismygearscore.com

WTF is My Gear Score?

As described on the site:

WTF is My Gear Score? is an online implementation of the formula from the popular yet oft-maligned GearScore addon for World of Warcraft, which quantifies the quality of a character's gear. We use the scores calculated to rank the top characters by region and realm.

This project is a rewrite of the original PHP codebase written by @alexbaumhoer and @xtian.

Setup

First, install Homebrew.

Then:

bin/setup

If you are not using Homebrew, you will need to manually install Postgres and Redis and then run bin/rails db:setup db:migrate

For development, you must provide a .env file with your Blizzard OAuth client ID and secret. See .env.sample for reference.

Starting the app

First, make sure Postgres and Redis are running.

Then:

foreman start

and visit http://127.0.0.1:3000

Running the tests

bin/test

Documentation

Documentation is written using Yard in Markdown format. Use this command to run a server hosting the generated HTML docs:

bin/yard server -r

Development

See CONTRIBUTING.md