February 2023 | Shawl Cohort | Prime Digital Academy
Discovering new video games and navigating online storefronts full of jargon can be an overwhelming and frustrating experience for people who have little to no experience with gaming. Plug N Play is a web application designed to help users who are new to the video game atmosphere view game recommendations that are tailored to their personal interests. Plug N Play will provide the ability to personalize recommendations appropriately based on a questionnaire taken upon registering.
Plug N Play is powered by Rawg.io's API service, which allows us to search their database of over 800,000 games. Of their available 9,800 search tags, we have hand-picked a little over 200 tags to use as search terms and user scores to power our search algorithm. Upon registering for a new account, a new user will fill out a survey. For each question, the user is asked to rate their preferences on a 9-point spectrum. Upon completing the survey, these answers will be processed and turned into user scores, which will inform future recommendations. This survey should only be completed once, but the algorithm will continue to be adjusted when users rate games in their "played" list.
- Clone this repo
- Navigate to the repo directory in the terminal
npm install- Obtain a RAWG.io API key from https://rawg.io/apidocs
- Create a .env file in the root of the project and enter:
`SERVER_SESSION_SECRET=[ enter a random string of numbers / letters ]`
`RAWG_API_KEY=[ enter the API key you obtained from RAWG.io ]`- Create the database according to the database.sql file.
- Start your PostgreSQL server
- In your terminal,
npm run server - In a separate terminal tab/window,
npm run client. This should open the app in your browser. - For the best user experience, right click and select Inspect, then click the Toggle Device Toolbar button and select iPhone 12 Pro for the dimensions.
- Create a new account, or login with an existing account.
- If you're a new user, answer all your survey questions and then tap ’Submit’ at the end.
- You will be taken to the recommendations view.
- Swipe up on a game to view details.
- Swipe right on games you might like.
- Swipe left on games you are not interested in.
- To view game details, swipe up and tap the Details button.
- On this page, you can add a game to your wishlist, played list, and/or ignore list.
- Liking or disliking a game on your played list will influence the algorithm and adjust your recommendations.
- Use the Collections tab to view the Glossary, your Wishlisted games, and your Played games.
- Use the Search tab to search for games by name or by genre.
- To view your Player Type and other account info, click the Profile tab.
- You can edit your profile image by clicking the gear icon.
If you have an administrator account, you can use your account to update and maintain the glossary.
- Log in to your administrator account, and navigate to the Profile page.
- In the top left, tap the shield icon to open the Manage Glossary page.
- From here you can add new glossary entries, as well as view, edit, and delete any existing entries.
This application has been deployed to Heroku to allow non-developers to experience it without any application setup. Simply visit the link below.
Note: If you are visiting from a laptop or desktop computer, be sure to right click upon page load, select Inspect, click the Toggle Device Toolbar button and select iPhone 12 Pro for the dimensions. This will put the application into a mobile friendly format which is how it is intended to be used.
Please see the Issues page for a comprehensive list of issues.
Thank you to:
- Our client, Maxine, for allowing us to bring her idea to life.
- Prime Digital Academy:
- The Shawl cohort
- Our instructors Dane, Liz, Kris, and Key
- Our family and friends, for all of the help and support