Light

ajmeese7 / steam-summary Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 1.0 1.04 MB

A Steam profile visualizer.

License: MIT License

JavaScript 59.96% CSS 19.70% PHP 8.85% HTML 11.49%

steam profile hacktoberfest

steam-summary's Introduction

♨️Steam Summary♨️

I looked around for a while for a good Steam profile visualizer and left disappointed, so I started working my own.

Setup

If you don't have your own Steam API key, go here to acquire one.

Create a file named env.php to include your Steam API key, and fill it like so:

<?php
  $token = 'YOUR_STEAM_API_KEY_HERE';
?>

Of course, replace the API key with your own, which you can get here. If you want to run the project locally, start the server by running the following command then visiting the URL in your browser:

php -S localhost:8000

You will need your own Google Maps API key for testing, as mine is restricted to the hosted domain to prevent abuse. You can find the instructions on how to do so here.

Contributing

Right now I think I have a pretty good setup for retrieving the Steam user's data, but the frontend still needs a lot of work.

If you're good with UI, your input here would be greatly appreciated. What I'm envisioning now is sort of a mix between the classic Steam interface and this GitHub profile visualizer.

Steam has these two APIs that allow me to get the info I need for this project. If you're looking for a place to start adding to this project, look for something I haven't added and get on it!

steam-summary's People

Contributors

Stargazers

Watchers

steam-summary's Issues

Add more features

Sites like this and the ones catalogued here are good inspiration for more features to be implemented into this project.

Graphs to display information

Take inspiration from this site for how some of the graphs and charts can look. There can be a chart for game genres owned by the user, how much playtime has been invested into each, the cost spend on each genre, etc.

Use JSON file on server side

The loading of the massive JSON file is what currently slows down the project the most. This can be resolved by doing all the processing on the server side, rather than loading the file to the client.

Improve mobile layout

The site currently needs a lot of work on mobile. I'm not sure if I'm going to leave this project vanilla like it is currently or pivot it to a modern framework like Next.js or React, but the pivot would probably make this process easier.

Accept other forms of ID

SteamID, Steam64, and Steam32 should all be acceptable input options in the input field.

Show geographic location

This project will convert the information provided by Steam into a location that can be displayed in text format.

Image storage

I'm going to replace this image soon, because I still have some formatting I need to work on and some features I want to add, but the project looks empty with no picture.

Shareable user URLs

Create player-specific URLs that can be visited by anyone, so profiles can be shared on social. Data will likely have to be stored and refreshed periodically, or upon visitation if the cache has expired.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.