Skip to content

jprusik/steam-gauge-ui

Repository files navigation

Steam Gauge UI

NOTE: THIS REPO IS A WORK-IN-PROGRESS REBUILD OF THE STEAM GAUGE FRONT-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 a dedicated React front-end app which serves as the user interface to the Steam Gauge back-end. This app is presently being migrated from Jinja/Python to React in order to improve overall app performance and make the codebase easier to maintain through the separation of concerns.

Requirements

  • yarn or npm package manager
  • (optional for development) Node.js
  • other dependencies can be found in package.json

Usage

  • yarn install or npm install to download the app dependencies
  • yarn start or npm start to run the react server
  • yarn build or npm run build to build the app for production

Deployment

  • build the app
  • run deploy-staging.sh or deploy-production.sh

Docker

If you have Docker installed, you can build and run a container to access the api

docker build -f Dockerfile.dev -t sgui:dev . && docker run --env-file ./.env -d -p 3000:3000 sgui:dev

Limitations & Known Issues

  • Presently, there is no testing to mitigate regressions.

Author

Jonathan Prusik @jprusik www.classynemesis.com