README.md

A proxy API providing endpoints to access Helldivers 2 API data

Project Setup

Environment Setup

For a sanitary environment, dev work should be done inside a Virtual Environment

python -m pip install --user --upgrade pip
python -m pip install --user virtualenv
python -m venv venv
# Windows
./venv/Scripts/activate
# Linux/MacOS
source ./venv/bin/activate
pip install -r ./requirements.txt

Project .env Setup

In ./src/cfg/env you can find a .env.example
This can be renamed to .env and used as is, and it will use api.diveharder.com
Or you may change the links to the AHGS API endpoints if you have them.

SECURITY_TOKEN is what you use to access the /admin/* endpoints
SESSION_TOKEN is for accessing AHGS APIs that require authentication

Local Deployment

docker build -t myappimage .
docker run --name myappname -p 1234:1234 myappimage

You are now fully setup, and can access your project at:

localhost:1234
localhost:1234/docs

Acknowledgements

@dealloc, @lambstream , and the @helldivers-2 organization