Skip to content

MinaSamirSaad/Would-You-Rather_React

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Would You Rather Project

this is the final assessment project for Udacity's React & Redux course.

The _DATA.js file represents a fake database and methods that let you access the data. The only thing you need to edit in the _DATA.js file is the value of avatarURL. Each user should have an avatar, so you’ll need to add the path to each user’s avatar.

Build Tools

  • HTML
  • CSS
  • JavaScript
  • React
  • Redux
  • Redux-thunk
  • React Router DOM.
  • Prettier.
  1. Move to the project folder
cd <project directory>
  1. Clone the repo
git clone https://github.com/MinaSamirSaad/Would-You-Rather.git
  1. Run the project locally
  • npm
  npm install 
  npm start 
  • Yarn
  yarn install 
  yarn start 

Usage

  • When the App is launched, you can select users from the options and login. Once the user logs in,
    • the home page is show with
      • The name of the authenticated user clearly displayed.
      • a "Logout" button to exit the App.
      • Contains all questions categorized into "Answered" and "Unanswered".
      • By default, a user is shown all unanswered questions first and then can navigate to answered questions by selecting the appropriate link.
      • Each question links to the question detail page.
    • the question details page
      • a user can vote by selection an option.
      • Vote results are shown immediately with the user's response,
      • The total number and percentage of votes for each option.
      • A logged-in user can vote on an option only once.
    • the leader-board page
      • users are ranked according the number of questions and answers submitted in descending order.
    • the "Add Question" page where they can input options and create a question.

The home page also

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"