Specification

Now that you’ve got the main foundations down to build out a frontend application, it’s time to prove to yourself that you own those skills! You’re going to be building a Rock Paper Scissors game from scratch!

Learning Goals

• Solidify and demonstrate your understanding of:
  • DRY JavaScript
  • event delegation to handle similar event listeners
• Understand the difference between the data model and how the data is displayed on the DOM
• Use your problem solving process to break down large problems, solve things step by step, and trust yourself to not rely on an outside “answer” to a logical challenge

Solo Project Expectations

This project is an important step in demonstrating you are ready to start Module 2. To ensure we can accurately assess that, it’s important you meet the expectations:

• You are the only one who should type code - no copy-pasting code!
• For any code that you didn’t write entirely by yourself (mentor or rock supported), you should be able delete it and re-write it yourself
• No youtube videos or tutorials of programming Rock Paper Scissors. If you have an opportunity and are tempted, do the right thing for YOUR learning and don’t do it!
• Any peer-to-peer collaboration should be discussions about IDEAS, not coding together or sharing code.

We want to see YOUR work.

Set Up & Submission

• Create a private repository and add your assigned instructor as a collaborator. (You cannot deploy private repositories to GitHub Pages; that’s ok. If you’d like, at the end of the project, you can make your repo public in order to deploy to GH pages.)
• Create a planning document where you outline your anticipated progress through the project. You can choose any format for this planning doc: Google Docs, a Gist, GitHub Projects, Trello, etc. You can add anything to this doc that will help you stay organized throughout the completion of this project. At minimum, it should include a timeline for when you’d like to complete each piece of functionality for the project.

Day One Deliverables

• By EOD on Kick Off Day: Complete this project submission form to ensure your project manager has the links to your repo and the planning doc.

Functionality

Here is a video demonstrating most functionality of the game:

In this project, we will not be providing detailed iterations. We want you to exercise your skills in planning out work!

Required Features:

• Both players’ wins should be displayed.
• Both players’ selected fighter icon should be displayed each round.
• Winner (or Draw) should be announced each round.
• A timeout is used after a completed round to reset the board.
• The overall layout should be the same but you can choose different colors and icons if you want to get creative with your with your Rock Paper Scissors design!
• This game is played by one user against a computer. The computer player should be another player object with the name of ‘computer’ and have the ability to make a random choice.
• You’ll need to make two versions of Rock, Paper, Scissors - “classic” and some variation. The variation should include more than 3 options (the one in the video has 5). You can invent your own variation, or do some research on variations here. Make sure you communicate the rules to your user!

Classic Rock Paper Scissors Rules

• Rock smashes scissors
• Scissors cuts paper
• Paper covers rock

We have provided some images to get you started, but feel free to find your own if you would like!

Architecture

Your entire application will consist of one HTML file, one CSS file and one JS file.

1. A main.js file that contains all of your JavaScript logic.
   • You’ll need a createPlayer function, that should return an object with the following properties:
     • name (ex: 'Human'), token (ex: '👩🏻'), wins (ex: 0)
   • You’ll need some of the following functions, but this is not an exhaustive list:
     • saveWinsToStorage - only necessary if you choose the localStorage extension
     • retrieveWinsFromStorage - only necessary if you choose the localStorage extension
     • takeTurn
   • A createGame function that should return a game object containing:
     • Two Player objects (player1 and player2)
     • A way to keep track of the data for the game board
     • A way to keep track of the selected game type
   • A separate function to check the game’s board data for win conditions
   • A separate function to detect when a game is a draw (no one has won)
   • A separate function to reset the game’s board to begin a new game

Data Model

In a game like Rock Paper Scissors, it is tempting to manipulate the DOM first. Remember that the game logic exists exclusively in the data model. The DOM simply reflects/displays that data model.

Suggested Iterations

This workflow is not required, but will help you meet the overall requirements of the project.

1. Plan out the HTML layout (colors and icons do not need to match, but overall layout should closely match the demo video)
2. Create the createPlayer function
3. Create the createGame function
4. Make game fully playable without the DOM (manually updating the game data, etc, from your console) to force yourself to think data-model-first
5. Create central game board on the DOM
6. Connect game data model to the DOM
7. Display the player data in the sidebars
8. Automatically reset the game board to allow for a new game to be played after the previous game is won
9. Optional Extension - Persist player data using local storage (number of wins should persist across page refreshes)
10. As an optional extension you could choose to keep your DOM related JavaScript in a separate JS file altogether. This is NOT a requirement or expectation of this project. If you finish with extra time and want to try refactoring your code to pull the DOM related JavaScript into a domUpdates.js file, be sure to do so on a branch so you aren’t breaking your finished, working code while you play with it.

Notes on Project Feedback

The rubric below serves as a guide for both students and instructors.

Students:

• It should be used as a reference throughout the project to keep on track and guide learning.
• It should also be used by students to self-assess their work.

Instructors:

• It should be used to evaluate the project at its final due date/time.
• It should be a guide to provide relevant feedback to students so they can grow and improve in the areas that need deeper understanding.

Final Project as Showcase

The evaluation will provide feedback by answering the only important question:

Does the project demonstrate student understanding of the learning goals & concepts of this module?

This project will answer that question, being marked as yes, not yet, and wow. Similarly, each section of the rubric (see below) will have yes/not yet/wow markings, helping you understand your progress and growth in specific areas.

The overall project outcome (yes, not yet, wow) is determined by “averaging” each section’s outcome. You can think of a “yes” being worth a 1, a “not yet” being worth a 0, and a “wow” being worth a 2.

An average that is above 0.5 is considered a yes - a passing project that demonstrates good student understanding! An average of 1+ is considered a wow. An average of 0.5 or below is considered a not yet - a project that indicates that the concepts have not been fully understood (see note in the section below).

Rubric

This project has 4 evaluated concepts. Please note that the rubric categories are not weighted equally. We will be using the following weights in order to determine your final score:

• Functionality: 1/3 of final score
• JavaScript: 1/3 of final score
• HTML: 1/6 of final score
• CSS: 1/6 of final score

Here is what the final score means in terms of completing the module:

• Wow: Student will complete module if prior project work, attendance, and final assessment corroborate readiness
• Yes: Student will complete module if prior project work, attendance, and final assessment corroborate readiness
• Not Yet Student needs more time with concepts and work covered in module

Please note that a passing project must include a fully playable game that includes all the required features outlined above.

Functional Expectations

As mentioned above, functionality does have more weight in this final project in order to demonstrate proficiency across the other criteria of the rubric. However, you should not pursue additional functionality at the expense of code quality. Well-refactored, thoughtful code is better than sloppy extra features.

Minimum Professionalism Expectations

• Commits are atomic and frequent, effectively documenting the evolution/progression of the application
• Developer uses PRs from feature branches before adding new code to the main branch.
• The README is formatted well and gives new contributors and employers sufficient context about the project:
  • Overview of project and goals, technologies used, your code architecture, future features, challenges, wins, and any other reflections
  • Setup instructions
  • Screenshots or video of your functioning app