An AngularJS app for displaying dota stats from the Steam Web API.
- Node.js and npm
- Redis. (There is a Windows version of Redis available at MSOpenTech/redis, clone and unzip the file in bin/release)
- A Steam API key. Get one here; http://steamcommunity.com/dev/apikey.
git clone https://github.com/verath/dota-stats.git
cd dota-stats
npm install
cd app/config
cp config.example.js config.js
Find the Google Analytics script in the public/index.html file. Either remove it entirely or change the Analytics id to your own.
This step is not completely mandatory, but very highly recommended. Without a cache for the Steam API the site will be very sluggish.
On windows this can be done by running the redis-server.exe file via cmd.
From the project root director run npm start
.
There are a couple of additional node modules necessary to develop the app.
npm install -g gulp
Gulp is the build tool used for the public side of the app. It handles the coffee-script to javascript compiling, combining of resources, minimization and various other things. See the gulpfile.js for the entire process.
It can be run on demand by running gulp
in the project root directory. It can also be set to
automatically run when files changes by running gulp watch
.
npm install -g bower
Bower is used for as much of the client-side dependencies as possible. These are all added to the public/bower_components directory, and are listed in the bower.json file.
To install a new dependency using bower run bower install --save ProjectName
. Also make sure to
include the new dependency in the index.html file. If the library is available on a CDN, one can
include that file directly. Otherwise, add it to the list of scripts/styles/images in the
gulpfile.js file to include it in the build.