Giter VIP home page Giter VIP logo

dota-stats's Introduction

Dota 2 Stats

An AngularJS app for displaying dota stats from the Steam Web API.

Deploy

Running the app locally

Prerequisites

1. Clone the repository

git clone https://github.com/verath/dota-stats.git

2. Download and install required node modules

cd dota-stats
npm install

3. Configure the app

3.1 Create and edit the config.js file for the backend.

cd app/config
cp config.example.js config.js

3.2 Edit the Google Analytics snippet

Find the Google Analytics script in the public/index.html file. Either remove it entirely or change the Analytics id to your own.

4. Run the app

4.1 Start the Redis server

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.

4.2 Start the app

From the project root director run npm start.

Developing

Dev dependencies

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.

dota-stats's People

Contributors

verath avatar gabrielcstr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.