Kimer stats

Pre-requisites

• node-js: The LTS version should suffice
• The leagueID of whatever league you're trying to pull stats from

First time usage

Any non-trivial NodeJS script has dependencies which need to be installed before the script can run. This installation is a one-time thing, you only need to do it before you run the script the first time. To install, open a command prompt/shell/... in the root directory of the project (in which you found this README) and execute the following command:

$> npm install

Accessing the Stratz API requires an API key token to be provided with all requests. You can obtain such an API key token by going to the Stratz API and scrolling down to the "My Tokens" section. This section is blurred out and can be made visible by clicking "Show Token Information" just below the blurred out box. Copy your token. Next, in the root folder of this project, create a file called .env. This file should only contain 1 line, namely STRATZ_API_KEY=eyJ...... where the part after the equals sign is your api key token. This token will be valid for 1 year

Running the application

To start the application, open a command prompt/shell/... in the root directory of the project (in which you found this README) and execute the following command, substituting <leagueId> with the ID of your league:

$> npm start <leagueID>

Running this command will start the parsing phase of the application, where it fetches the statistics from Stratz and OpenDota. This happens in two phases: the first phase fetches the match id's in the league from Stratz, the second phase pulls stats for those match id's from OpenDota. Depending on how many matches have already been played in the league, this part can take several minutes. The API's the script is calling have flood protection and don't appreciate getting slammed with requests. When all the stats have been fetched and parsed, a message will appear indicating that the server is now listening.

The output you'll see on screen will look like the following:

$> npm start

> [email protected] start /path/to/directory
> node server.js "leagueId"

Fetching first batch
Fetching next batch
Fetching opendota matches
Listening on port 3000

If you now point your browser to http://localhost:3000, you will see a page allowing you to select the time period for which you want to pull statistics. Entering the dates and clicking Stats will show you the statistics.

Customization

views/index.pug

This file contains the structural layout of the stats page. If you want to adapt text, this is the place to look.

public/css/style.css

This file contains all the markup of the stats page. If you want to adapt font, colour, size, ... this is the place to look.

server.js

Sick and tired of always having to type the league id? You can hard-code it in here!