Git Product home page Git Product logo

acahet / udacity-would-you-rather-proj Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 494 KB

A web app that lets a user play the “Would You Rather?” game. The game goes like this: A user is asked a question in the form: “Would you rather [option A] or [option B] ?”. Answering "neither" or "both" is against the rules.

Home Page: https://udacity-would-you-rather-proj.vercel.app

JavaScript 92.90% HTML 4.24% CSS 2.86%

udacity-would-you-rather-proj's Introduction

@Author: Anderson Cahet

Would You Rather Project - Udacity Course

Clone repository and run NPM install and NPM start

Landing Page:

  • Dropdown with seeded users
  • Login btn - disabled until a user is selected
  • Sign-up btn - allows new users to be added
    • avatar image needs to be an actual image URL
    • on sign-up user is taken back to landing page

On Login

  • user lands on home where by default the unanswered questions will be displayed

Unanswered Questions

  • on View Poll Click
    • user is able to select an option
    • no answer select, submit is disabled
    • on submission results is displayed with a trophy on the question selected by user
  • all unanswered question answered
    • message is displayed to user

Answered Questions

  • case empty
    • message displayed - can be seen with a newly created user
  • answered questions displayed
  • on View Poll Click
    • results is displayed as when a vote is placed

New Question

  • inputs for optionOne and optionTwo , plus a disabled submit btn
    • validation:
      • same questions not allowed - submit btn disabled
      • both fields or one empty - submit btn disabled
    • on submission
      • user is taken to Unanswered view and created question is displayed

Leader Board

  • displays the score based on total of answered + created questions

Header

  • has a label with greeting user by name and a logout btn

Logout

  • sets authenticate user to null and returns to login page

Page Not Found

  • user tries to access an non-existent URL page displays with a button to return to login page

Access through url

  • user is taken to login page even if the url is correct

References: Private Routes https://ui.dev/react-router-v4-protected-routes-authentication/

Data

There are two types of objects stored in our database:

  • Users
  • Questions

Users

Users include:

Attribute Type Description
id String The user’s unique identifier
name String The user’s first name and last name
avatarURL String The path to the image file
questions Array A list of ids of the polling questions this user created
answers Object The object's keys are the ids of each question this user answered. The value of each key is the answer the user selected. It can be either 'optionOne' or 'optionTwo' since each question has two options.

Questions

Questions include:

Attribute Type Description
id String The question’s unique identifier
author String The author’s unique identifier
timestamp String The time when the question was created
optionOne Object The first voting option
optionTwo Object The second voting option

Voting Options

Voting options are attached to questions. They include:

Attribute Type Description
votes Array A list that contains the id of each user who voted for that option
text String The text of the option

Your code will talk to the database via 4 methods:

  • _getUsers()
  • _getQuestions()
  • _saveQuestion(question)
  • _saveQuestionAnswer(object)
  1. _getUsers() Method

Description: Get all of the existing users from the database.
Return Value: Object where the key is the user’s id and the value is the user object.

  1. _getQuestions() Method

Description: Get all of the existing questions from the database.
Return Value: Object where the key is the question’s id and the value is the question object.

  1. _saveQuestion(question) Method

Description: Save the polling question in the database.
Parameters: Object that includes the following properties: author, optionOneText, and optionTwoText. More details about these properties:

Attribute Type Description
author String The id of the user who posted the question
optionOneText String The text of the first option
optionTwoText String The text of the second option

Return Value: An object that has the following properties: id, author, optionOne, optionTwo, timestamp. More details about these properties:

Attribute Type Description
id String The id of the question that was posted
author String The id of the user who posted the question
optionOne Object The object has a text property and a votes property, which stores an array of the ids of the users who voted for that option
optionTwo Object The object has a text property and a votes property, which stores an array of the ids of the users who voted for that option
timestamp String The time when the question was created
  1. _saveQuestionAnswer(object) Method

Description: Save the answer to a particular polling question in the database. Parameters: Object that contains the following properties: authedUser, qid, and answer. More details about these properties:

Attribute Type Description
authedUser String The id of the user who answered the question
qid String The id of the question that was answered
answer String The option the user selected. The value should be either "optionOne" or "optionTwo"

udacity-would-you-rather-proj's People

Contributors

acahet avatar

Watchers

James Cloos avatar  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.