- This project aims to provide free, open source, highly detailed match and player statistics for the Dota 2 community.
- Raw data comes from the WebAPI provided by Valve and fully automated parsing of match replays (.dem files).
- Processed data is accessible through a REST API and published data dumps.
- API documentation: https://swagger.yasp.co
- Data dumps: http://academictorrents.com/collection/yasp-data-dumps
- Examples of applications built on the platform:
- Website: https://github.com/yasp-dota/ui
- Mobile App: https://github.com/yasp-dota/mobile
- Blog: https://blog.yasp.co
- Servers for a public deployment of this code are funded by contributions from community members and corporate sponsors.
- Community developers maintain the codebase without compensation, reducing operating costs.
- Web/Microservices: Node.js
- Storage: PostgreSQL/Redis/Cassandra
- Parser: Java (powered by clarity)
- Install Docker:
curl -sSL https://get.docker.com/ | sh - Clone the repo:
git clone https://github.com/yasp-dota/yasp - Go into the directory:
cd yasp - Start containers and initialize databases:
sudo bash scripts/dev.sh - Create .env file with required config values in KEY=VALUE format (see config.js for a full listing of options)
cp .env_example .envSTEAM_API_KEYYou need this in order to access the Steam Web API.STEAM_USER, STEAM_PASSThe retriever requires a Steam account in order to fetch replay salts. We recommend creating a new account for this purpose (you won't be able to log into the account while the retriever is using it). If you don't care about getting replay salts/downloading replays then you can skip this step.
- Get a terminal into the running container:
sudo docker exec -it yasp bash - Rebuild inside the container (your local directory hides the built files):
npm run build - Start the services you want to run:
pm2 start profiles/basic.jsonThis starts all the basic services to be able to read the API and request parses (which is a useful end-to-end test). Useprofiles/everything.jsonto start everything.- Useful PM2 commands:
pm2 start svc/web.js --watchThis starts a specific service and watches it for changes.pm2 logs webYou can use this command to inspect the output of a service.pm2 delete allStop and remove all the services.
- Useful commands
npm testruns the full test suite. Usemochafor more fine-grained control over the tests you want to run.sudo docker build -t yasp/yasp .rebuilds the Docker image. If you are editing theDockerfile, do this to ensure it works.
- Get some starter data
- You can request some parses by ID to get some parsed data.
- You can also run
scannerto get some matches from the API.
- File changes you make outside the container should be automatically mirrored to the container.
- Make some changes and commit them:
git add --all; git commit -m "My first commit!" - Submit a pull request. Wait for it to be reviewed and merged.
- Congratulations! You're a contributor.
- Alternatively, if you have Docker Compose installed you can just run
docker-compose up. - 3 containers will be built and launched - one with postgres database, one with redis and one with web service.
- Database is inited and tables are created automatically.
- By default, minimal configuration necessairy to open the site in a browser and request parses by ID is started. This can be overridden via
docker-compose.override.yml. sudo docker exec -it yasp_web_1 bashwill give you a terminal into the running web container.
- Feel free to open a new issue to ask questions/get help!
- You can also find us on Discord if you'd like real-time help.
- The following blog posts may help you understand the codebase/architecture:
- General Learnings: https://blog.yasp.co/2016/05/13/learnings/
- Architecture: https://blog.yasp.co/2016/05/15/architecture/
- UI/web design experts. We want to improve the user interface and would appreciate any expertise you can contribute. See https://github.com/yasp-dota/ui
- Project started in August 2014
- Forked from https://github.com/RJacksonm1/matchurls, created in July 2013