Steam Widget - UOA-SE701-Group3-2021/3Lancers GitHub Wiki
Documentation for using the Steam Widget
The endpoints for the steam API endpoint in Telos can be found here.
Design Intention
The Steam Widget is intended as a way for users to track the completion of their owned games. This means the widget is focused on rest and relaxation as opposed to productivity as there is only so much time you can be focused on working.
Requirements
The widget will take a steam vanity name and use that to retrieve a list of owned games.
- Generate a Steam Web API Key
- Navigate to the backend and export your steam key as an environment variable (
STEAM_KEY
) in the backend terminal. The data will be sent to steam.js telos-backend\src\routes\api\steam.js. Use the syntax shown in the screenshot below (Note: if you're using mac or linux, useexport
instead ofset
)
-
Open the file steam.jsx located in
frontend\src\components\steam\
and add your steam username into line 7 -
Run the code with
npm start
on the frontend and backend
- Note: This will only get owned games for the person who generated the API key, their friends, and public steam profiles