Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jomendez/would-you-rather
Udacity react-redux project
https://github.com/jomendez/would-you-rather
Last synced: 5 days ago
JSON representation
Udacity react-redux project
- Host: GitHub
- URL: https://github.com/jomendez/would-you-rather
- Owner: jomendez
- Created: 2020-06-08T21:31:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T04:43:08.000Z (almost 2 years ago)
- Last Synced: 2024-03-18T05:10:58.094Z (8 months ago)
- Language: JavaScript
- Size: 1.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Would You Rather Project
Final assessment project for Udacity's React & Redux course.
## Run the project
Make sure you have nodejs installed, clone, fork or download the sourcecode and the run the followings commands:
```
npm install
yarn start
```Notes:
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.
Using the provided starter code, you'll build a React/Redux front end for the application. We recommend using the [Create React App](https://github.com/facebook/create-react-app) to bootstrap the project.
## 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.2) `_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.3) `_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|4) `_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"`|