NOTE: THIS REPO IS A WORK-IN-PROGRESS REBUILD OF THE STEAM GAUGE BACK-END AND PRESENTLY LACKS FEATURE PARITY AND OPTIMIZATIONS SUITABLE FOR PRODUCTION ENVIRONMENTS.
Steam Gauge is a collection of web apps driven by technologies like Flask and React in order to produce data-rich Steam account summaries.
This repository represents development of the dedicated Flask back-end API app which can not only handle and respond to requests to project's data stores, but also serves as a pass-through to Valve's developer APIs, including the Web and Big Picture APIs. This app has undergone several revisions (including a migration from Python 2 to 3) and is presently being refactored to utilize improved software design patterns.
- Python 3.6.5 or higher (earlier versions of Python 3 have not been tested)
- Package requirements can be found in
requirements.txt
and installed with pip (Note: if you opt to use MySQL, you may have to download andmake
mysql-connector-python manually) - (Optional) Pipenv
- Create
.env
in the app directory and give values to your app constants (see.env.example
). - To run locally, execute
wsgi.py
with Flask from the app root:flask run
. - Alternatively, the app can be run via Pipenv with the command
pipenv run flask run
. - Access with your client (by default) at
http://localhost:5000
.
If you have Docker installed, you can build and run a container to access the api
docker build -f Dockerfile.dev -t sgapi:dev . && docker run --env-file ./.env -d -p 5000:5000 sgapi:dev
- Presently, there is no testing to mitigate regressions.
Jonathan Prusik @jprusik www.classynemesis.com