Giter VIP home page Giter VIP logo

project-2-rpsls's Introduction

Rock Paper Scissors Lizard Spock Game

RPSLS is a game where you choose one of the following, Rock, Paper, Scissor, Lizar or Spock and the computer randomly chooses one as well. Then if you won you get a score added or if the computer won it gets a score added. The game score goes to 5 and which one reaches it before wins the game.

Welcome to the journey through Rock Paper Scissors Lizar Spock

RPSLS responsive design

Contents

User Experience (UX)

Wireframes

The wireframes for Restaurant were produced in Figma. There are frames for a full width display. The final site varies slightly from the wireframes due to developments that occured during the creation process.

Desktop wireframe image

Desktop wireframe image

Desktop wireframe image

Desktop wireframe image

Back to top

Site Structure

RPSLS game has two pages. The home page is the default loading page and the Game page

Back to top

Design Choices

  • Typography

    The fonts chosen were 'Montserrat' for all fonts in the game. They fall back to sans-serif respectively.

  • Colour Scheme

    The colors are very bright and fun. They were chosen to brighten up the game and give some lightness to it.

Colour Palate image

Back to top

Features

RPSLS game is a game for fun. The landing page has the instructions and then you start the game and choose your weapon to combat the computer.

Existing Features

  • Landing-page

    • This is the landing page which you start on, it is fully responsive and contains link to the main game page.

Landing page image

Back to top

  • Main-game-area

    • This is the main game area, where you choose your weapaon and play against the computer.

Main game area image

Back to top

  • Main-game-area-game-in-progress

    • Here you can see the game in progress, the layout of game choices and result text.

Main game area - in progress image

Back to top

  • Main-game-area-Won-game

    • This is the screen that comes up if you win the game! Here you can see the result and also you can reset the game and try again.

Main game area won image

Back to top

  • Main-game-area-Lost-game

    * This is the screen that comes up if you lose the game! Here you can see the result and also you can reset the game and try again.
    

Main game area lost image

Future Features

  • Game

    • Add audio to gameplay.
    • Add animations to the game.

Back to top

Technologies Used

  • HTML5 - provides the content and structure for the website.
  • CSS - provides the styling.
  • JavaScript - provides the function of the game.
  • Figma - used to create the wireframes.
  • Gitpod - used to deploy the website.
  • Github - used to host and edit the website.

Back to top

Testing

Code Validation

The RPSLS game site has be throughly tested. All the code has been run through the W3C html Validator the W3C CSS Validator and JSHint javascript validator. Errors were found. After a fix and retest, no errors were returned.

The HTML validator results for each page are below:

  • Home page

W3C Validator test result

  • Main game page

W3C Validator test result

The CSS validator results are below:

CSS Validator test result

The JavaScript validator results are below:

Metrics There are 11 functions in this file.

Function with the largest signature take 1 arguments, while the median is 0.

Largest function has 10 statements in it, while the median is 2.

The most complex function has a cyclomatic complexity value of 6 while the median is 2.

Back to top

Responsiveness Test

Moto G4 Galaxy S5 iPhone 5 iPad iPad Pro Display <1200px Display >1200px
Render pass pass pass pass pass pass pass
Images pass pass pass pass pass pass pass
Links pass pass pass pass pass pass pass

Note: On wide display types the contents of the site are restricted in width to 2000px. This helps the UX by not spreading the content too wide on the extra wide screens.

Browser Compatibility

RPSLS game was tested on the following browsers with no visible issues for the user. Google Chrome, Microsoft Edge, Safari and Mozilla Firefox. Appearance, functionality and responsiveness were consistent throughout for a range of device sizes and browsers.

Performance Test

Lighthouse report

Back to top

Known Bugs

  • Resolved

    • During validation two bugs became known during the validation stage, a brief description is below:

    • CSS - Wrong attribute for one of the text elements. Fixed.

  • Unresolved

    • JavaScript warnings in the JShint validator.

Back to top

Deployment

To deploy the project

The site was deployed to GitHub pages. The steps to deploy a site are as follows:

  1. In the GitHub repository, navigate to the Settings tab.
  2. Once in Settings, navigate to the Pages tab on the left hand side.
  3. Under Source, select the branch to main, then click save.
  4. Once the master branch has been selected, the page will be automatically refreshed with a detailed ribbon display to indicate the successful deployment.

GitHub pages deployed image

The live link to the Github repository can be found here - https://johannes2503.github.io/Project-2-RPSLS/

To fork the repository on GitHub

A copy of the GitHub Repository can be made by forking the GitHub account. This copy can be viewed and changes can be made to the copy without affecting the original repository. Take the following steps to fork the repository;

  1. Log in to GitHub and locate the repository.
  2. On the right hand side of the page inline with the repository name is a button called 'Fork', click on the button to create a copy of the original repository in your GitHub Account.

GitHub forking process image

To create a local clone of this project

The method from cloning a project from GitHub is below:

  1. Under the repository’s name, click on the code tab.
  2. In the Clone with HTTPS section, click on the clipboard icon to copy the given URL. Cloning image
  3. In your IDE of choice, open Git Bash.
  4. Change the current working directory to the location where you want the cloned directory to be made.
  5. Type git clone, and then paste the URL copied from GitHub.
  6. Press enter and the local clone will be created.

Back to top

Credits

Content

Back to top

Acknowledgements

The Game was completed as a Portfolio 2 Project piece for the Full Stack Software Developer (e-Commerce) Diploma at the Code Institute. As such I would like to thank my mentor Precious Ijege, the Slack community, and all at the Code Institute for their help and support. Also want to thank Ewan Colquhoun for the README.md template which this readme is based on.Ewan Colquhoun.

Johannes Hreinsson 2022.

Back to top

project-2-rpsls's People

Contributors

johannes2503 avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.