Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.24 KB

README.md

File metadata and controls

36 lines (28 loc) · 2.24 KB
Raw

contributions welcome

Initial setup

  1. Make sure you have Docker and npm installed
  2. If you wish to take advantage of the scripts and make commands listed below you need some form of bash (i.e Git Bash)
  3. You will need a Steam account to use this application

Mac Users

Ensure that you have the XCode Toolkit installed. If not follow the below steps:

  1. Launch your terminal
  2. Enter the following command xcode-select --install
  3. Click install on the prompt that follows
  4. Wait for install to finish and continue down this list

Setup development

  1. Fork/clone this repository
  2. Create an account on BitSkins
  3. In account settings enable Secure Access and API Access
  4. Take note of the BitSkinsSecret that is given when enabling API Access (underneath the QR code)
  5. Take note of your BitSkins API Key that can be found in your settings
  6. Get your Steam API Key at this site, when asked to enter a domain simply enter localhost or your GitHub repo
  7. With the BitSkins API Key, BitSkinsSecret, and Steam API Key noted down run ./scripts/make-env-files in bash and enter corresponding values as prompted. If you run into a permission denied issue while attempting to run this script give yourself the appropriate permissions with sudo chmod 755 ./scripts/make-env-files
  8. While still in the root run the command make build
  9. After the containers finish building run make up
  10. Navigate to http://localhost:3000/ and ensure the app is running

How to use

  1. From the main page of the application enter any user's 64 bit Id or vanity name if the targeted user has that set up. A quick way to find them is through this site
  2. Click the Search button
  3. Ensure the user's inventory is loaded, if not check the .env file has the correct secret and key information
  4. After loading and generating prices a table will be displayed with the user's items and the total value of their inventory
  5. Click home and repeat