https://github.com/jprusik/steam-gauge-ui

Steam Gauge's React-driven frontend
https://github.com/jprusik/steam-gauge-ui

bigpicture react reactjs steam steam-account steam-api steam-community typescript valve

Last synced: 8 days ago
JSON representation

Steam Gauge's React-driven frontend

• Host: GitHub
• URL: https://github.com/jprusik/steam-gauge-ui
• Owner: jprusik
• Created: 2018-09-02T18:57:56.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-03T21:35:25.000Z (3 months ago)
• Last Synced: 2024-08-03T22:34:40.155Z (3 months ago)
• Topics: bigpicture, react, reactjs, steam, steam-account, steam-api, steam-community, typescript, valve
• Language: TypeScript
• Homepage: https://www.mysteamgauge.com
• Size: 2.89 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Steam Gauge UI

**NOTE: THIS REPO IS A WORK-IN-PROGRESS REBUILD OF THE [STEAM GAUGE](https://github.com/jprusik/steam-gauge) FRONT-END AND PRESENTLY LACKS FEATURE PARITY AND OPTIMIZATIONS SUITABLE FOR PRODUCTION ENVIRONMENTS.**

[Steam Gauge](https://www.mysteamgauge.com) is a collection of web apps driven by technologies like [Flask](http://flask.pocoo.org) and [React](https://reactjs.org) 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](https://yarnpkg.com) or [npm](https://www.npmjs.com/) package manager

- (optional for development) [Node.js](https://nodejs.org/)

- 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

```shell

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](https://github.com/jprusik)

www.classynemesis.com