/hsreplaynet-localstack

HSReplay.net local Docker dev stack

Primary LanguagePythonMIT LicenseMIT

HSReplay.net Local Stack

This repository allows you to run HSReplay.net on your local machine.

Dependencies

Setup

Run ./firstrun.sh once you have docker-compose installed the first time you set up the image. That script will do the following:

  1. Clone HSReplay.net in the repository if it's not already there. You should use that path as your workspace if you want to modify the site.
  2. Prepare and build the docker images for all the services.
  3. Set up the local database, migrate it, and feed in some initial data.

The first time the app is run, pipenv (from the docker container) will install all the HSReplay.net dependencies in the ./HSReplay.net/.venv environment. This can take several minutes. Because the venv is in the HSReplay.net folder, it continues to exist even if you destroy and recreate the container. Any changes you make to that venv, such as package upgrades, will persist on disk.

Services list

The following services are available on their default ports:

The site runs on the following ports:

  • django (localhost:8000)
  • frontend (localhost:3000 for webpack-dev-server)

License & Community

This is a HearthSim project. Join the development on Discord, or #HearthSim on Freeenode.

Licensed under the MIT license. The full license text is available in the LICENSE file.