Skip to content
/ Steami Public

Project week, Makers Academy. Fully functioning REACT app which returns API calls from Steam

Notifications You must be signed in to change notification settings

bvjones/Steami

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Steami

Steami is a single page Universal Javascript app built on the MERN stack that summarises a user's Steam profile, showing their account statistics, games and achievements. Made by Rick Clark, Ben Vaughan-Jones, Dylan Rhodius and Frankie Shaw.

Click here to try out the demo on Heroku.

Technologies

  • Mongodb: an open source database that uses a document-oriented data model
  • Express: a web application framework
  • React: a declarative, efficient, and flexible JavaScript library for building user interfaces
  • React Router: A routing library for React
  • Node.js: an open-source, cross-platform JavaScript runtime environment
  • Passport: an authentication middleware for Node

Testing

  • Enzyme: a JavaScript Testing utility
  • Mocha: a feature-rich JavaScript test framework
  • Sinon: a testing library
  • Chai: a unit testing library

Installation

Ensure you have MongoDB installed and available locally on port 27017, and you have updated to the latest stable versions of Node.js and npm.

Then:

  • Clone this repo
  • Change into the Steami directory
  • Run npm install to install dependencies

Usage

  • Host the server by running npm start
  • Go to your browser and visit http://localhost:3000/.

You should see this button:

Button Screenshot

Clicking it will redirect you to the Steam authentication sign in page, hosted by Valve. Signing in will redirect you to the Steami homepage where you will be able to see your Steam profile:

Homepage Screenshot

To see more information on a particular game, simply click it. You will then see your total time played on the game and all of your completed and outstanding achievements. Mouse over an achievement to see its name and description:

Gamepage Screenshot

Testing

To run the tests, simply run npm test

Test specs are stored in the 'test' folder.

About

Project week, Makers Academy. Fully functioning REACT app which returns API calls from Steam

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published