Skip to content

A spin on the classic rock, paper, scissors game for all Big Bang Theory fans out there. Built using HTML, CSS & JavaScript

Notifications You must be signed in to change notification settings

CaraMcAvinchey/rock-paper-scissors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ROCK, PAPER, SCISSORS, LIZARD, SPOCK GAME

Author

Cara McAvinchey

Project Overview

  • For fans of Big Bang Theory, this twist on the classic rock, paper, scissors game designed using JavaScript hopes to bring enjoyment to those who would like a 5 minute break whether at home or at work. The sight allows users to play against Sheldon Cooper using 'lizard' and 'spock' as additional choices.

You can view the deployed website here

image

TABLE OF CONTENTS

UX

Project Goal

  • The project goal is to create a fully functioning and responsive game using JavaScript.

User Stories

  1. As a first time visitor,

    • I want to be able to play the game quickly and learn the rules fast.
    • The rules need to be clear to understand and easy to refer back to if needed.
  2. As a returning visitor,

    • I want to be able to start playing the game once I load the page with very few clicks.
    • If I forget the rules, I want to be able to refer back to the rules quickly.

User Profiles

  1. Paul commutes to work via subway each morning and enjoys a quick 5 minute game as he travels.
  2. Lisa enjoys a short game between meetings or whilst waiting for appointments. As a Big Bang Theory fan, she enjoys sharing the game with her friends.

DESIGN CHOICES

Colors

  • The space background image inspired the color palette of the website and links to the theme of the game.
  • The headings and body text are white to ensure clear contrast and readability for the user.
  • Background of the header and footer is a light purple to ensure clear contrast and delineation between sections.
  • All text and icon elements have a semi-transparent purple background to ensure the text has contrast from the background.
  • The icons are orange to add contrast from the purple palette.

image

Typography

  • The logo and headings use ZCOOL QingKe HuangYou and body text uses Open Sans with a fall-back font of san-serif.
  • The choice of fonts were selected using Google Fonts.
  • The headings decrease in size to ensure full responsiveness of the website.

image

image

Images/Icons

  • The background image matches with the space theme of the game and creates a sense of depth without disrupting the foreground.

image

  • The rules image provides a clear diagram of the game moves and results.

image

  • The icons are used consistently across the site for game controls and in the rules.

image

Animations

  • The buttons across the site have a subtle grow effect when hovered over by the user.

image

Responsiveness

  • The website was designed using flexbox instead of float or grid to avoid fixed heights and ensure responsiveness throughout the website.

WIREFRAMES

Mobile

image

Desktop

image

FEATURES

Welcome Area

  • The users are greeted with a menu allowing them to either play the game or read the rules first.
  • The close and quit buttons help to easily navigate between areas of the website.

image

image

image

Game Score Area

  • The game score area shows the icons of each user and their move. The score increments and a message is displayed to show the user the result of their move.

image

Game Controls

  • The controls are buttons with hand icons to easily distinguish between each control.
  • If on a smaller screen size, the buttons will respond by stacking on each other.

image

Game Rules

  • The user has a choice of image or info graphic table to refer to when learning the moves.

image

image

JavaScript Enable Message

  • This message will appear for users who do not have JavaScript enabled on their browser.

image

Footer

  • This footer includes links to the relevant social media sites for game development group who created the site. The links will open to a new tab to allow easy navigation for the user.
  • First time users and returning users will be able to connect with players via social media.

image

Error

  • This page was created in case of any broken links or issues. It is styled the same as the rest of the site for familiarity for the user.
  • The page includes the navigation which will allow the user to go back to the home page or any page they were previously on.

image

Features for Future Development

  • Future opportunities for the game include adding a high score function to be able to compete with other users and allowing scores to be saved once a user returns to play again.
  • Audio for the game when a user wins or loses can add more interest.
  • Adjusting the 'It's a win/lose/tie' text to be insults from Sheldon Cooper himself.

TESTING

Validation Testing

  • HTML
    • No errors were returned when passing through the official HTML validator

image

  • CSS
    • No errors were found when passing through the CSS validator.

image

  • JS validation
    • No errors found when passing through the JS validator.

image

Cross Browser and Cross Device Testing

  • The below combination of devices, browsers, and operating system were used to test the website. A range of viewport sizes were checked to see if users would have the same experience across multiple devices and browsers.
TOOL / Device BROWSER OS SCREEN WIDTH
dev tools: Galaxy Fold Chrome android 280 x 653 px
dev tools: iPhone SE safari iOs 375 x 667 px
dev tools: Pixel 2 Chrome android 411 x 731
real phone: iPhone XR safari iOs 414 x 896 px
browserstack: Nexus 7 Firefox android 960 x 600 px
browserstack: iPhone 13 Pro safari iOs 390px × 844px
real tablet: iPad Pro 11 Chrome iOs 834 x 1075 px
real laptop: Macbook Pro Firefox & Chrome iOs 1400 x 766 px
broswerstack Firefox iOs 1440 x 672 px
browserstack Edge 99 windows 1440 x 672 px

Testing User Stories from User Experience (UX) Section

First time visitor:

  1. As a first time visitor, I want to be able to play the game quickly and learn the rules fast. The rules need to be clear to understand and easy to refer back to.
    1. The welcome area with the menu will allow users to navigate the page quickly and easily as needed.
    2. The rules are displayed both as a visual and infographic grid.

Returning visitor:

  1. As a returning visitor, I want to be able to start playing the game once I load the page with very few clicks. If I forget the rules, I want to be able to refer back to the rules quickly.
    1. The close and quit buttons will help users navigate between the rules and game area.

Manual Testing

  • You can view manual testing of the website here

Outstanding Defects

  • The footer doesn't remain fixed at the bottom of the site on all screen sizes, this isn't obvious to the user and doesn't clash with other elements. This will be fixed in future debugging.

Defects of Note

  1. The resizing of the game section for smaller screen sizes had many challenges. Flexbox solved most of the issues using media queries.

ACCESSIBILITY

Lighthouse Audit

  • The deployed website was run through web.dev measure to check performance, accessibility, best practices and SEO scores.

image

Keyboard Navigation

  • The user will be able to use the tab, arrow and enter keys if needed when navigating the website.

DEPLOYMENT

  1. Click on the settings link in the menu:

image

2. In the left hand menu, click on the pages link:

image

3. In the sources section of the GitHub pages, click on the dropdown menu to select main as the source:

image

4. After you've selected main, hit the save button:

image

5. Eventually you'll see a blue area with the deployment URL and a success message:

image

CREDITS

Media

  • The pairing of ZCOOL QingKe HuangYou and Open Sans were chosen using Google Fonts.
  • The colors for the website was generated using Coolers.co.
  • The background image was sourced using Pexels.
  • The game rules image was sourced using Creative Commons Search.
  • The icons for the favicon, footer, about page and location headings were taken from Font Awesome.
  • The favicon image was converted using Favicon.io.

ACKNOWLEDGEMENTS

  • Thank you to my mentor for continuous helpful feedback and support throughout the project.
  • The tutors at Code Institute for their patience and support.
  • The Code Institute Slack community for tips and guidance.

Back to the beginning

About

A spin on the classic rock, paper, scissors game for all Big Bang Theory fans out there. Built using HTML, CSS & JavaScript

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published