https://github.com/dgautsch/steam-roi

An app to find out a steam game's ROI
https://github.com/dgautsch/steam-roi

expressjs hacktoberfest javascript mongodb mongoose steam-api vue vuex

Last synced: about 2 months ago
JSON representation

An app to find out a steam game's ROI

• Host: GitHub
• URL: https://github.com/dgautsch/steam-roi
• Owner: dgautsch
• License: mit
• Created: 2018-01-23T00:35:05.000Z (almost 7 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-07T12:18:12.000Z (about 2 years ago)
• Last Synced: 2024-10-20T21:32:49.429Z (2 months ago)
• Topics: expressjs, hacktoberfest, javascript, mongodb, mongoose, steam-api, vue, vuex
• Language: JavaScript
• Homepage:
• Size: 3.25 MB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Steam ROI

An app to find out a steam game's ROI

## Scope

This app is hosted at https://steam-roi.herokuapp.com (USE AT YOUR OWN RISK). I haven't had time to security check the app as it is purely a proof of concept project. Logging-in allows you to see your steam account details.

The heroku hosted site is the original protoype for the site. The current `dev` branch is the Vue SSR refactor.

## Purpose

Eventually, when you log into this app you will be able to see the games you own and how much time you played versus the dollars spent on the game. You can then effectively determine your ROI by how much each hour of time played cost you.

## In Progress

- [x] Unit testing framework

- [x] Sass compilation for global styles

- [x] State hydration, VueX

- [x] Implement Vue Router

- [x] Address `connect.session() MemoryStore is not designed for a production environment, as it will leak`

- [x] Fix config so variables are shared server to client

- [x] Add auth middleware to secure private routes

- [x] Add vue router auth meta to secure private routes

- [ ] Create server process to scrape steam API for game data

- [ ] Setup API route to get scraped games from app database

- [x] Implement prettier plugin for vue to ignore templates

- [ ] Add a 404 page

- [x] Fix routes being title cased e.g. `Router` vs `router`

## Running the Site

In order to run this project you can follow the steps below. The site can be run without a database but you will lose

the majority of functionality for the site.

- Install a local or cloud instance of Mongo. Get the connection string for the mongo DB.

- Add a `.env` file to the `config` folder.

- Update the file with your Mongo connection string.

- Update the file with your Steam API key if you have it. (Currently not necessary as the steam functionality is not hooked up in this version.)

- Run `npm ci`

- Run `npm run dev`

- Connect to the site at http://localhost:3000