Skip to content
/ hotsapi Public archive

An open Heroes of the Storm replay database where everyone can download replays

License

Notifications You must be signed in to change notification settings

hotsapi/hotsapi

Repository files navigation

HotsApi Build Status Join Discord Chat

HotsApi.net is an open Heroes of the Storm replay database where everyone can download replays. It stores replays in a public AWS S3 bucket (currently in "Requester pays" mode) and provides an API to query replay metadata. Use Hotsapi.Uploader (repo link) to upload your replay files.

There are API libraries for Ruby and Python

Currently API is still in alpha and may change

Installation

You need to have docker and docker-compose installed on your machine

cp .env.example .env
# edit env file if needed

# bring up mysql service
docker-compose up -d mysql

# run migrations 
docker-compose run artisan migrate:fresh --seed

# populate maps, heroes, talents tables
docker-compose run artisan hotsapi:fetch-translations
docker-compose run artisan hotsapi:fetch-talents

# install composer dependencies locally because we are using local files instead of content dir from the container
docker-compose run --entrypoint 'composer install' hotsapi

# run webserver, available at localhost:8080
docker-compose up -d hotsapi

# Look at logs
docker-compose logs -f

# parse uploaded replays
docker-compose run artisan hotsapi:parse

Contributing

Pull requests are very much appreciated. With community involvement we could get much more features in much shorter time. You can see the list of current tasks in project page. You can freely pick one from "backlog" or "high priority" columns and start working on it.

About

An open Heroes of the Storm replay database where everyone can download replays

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published