Skip to content

Latest commit

 

History

History
92 lines (71 loc) · 3.18 KB

README.md

File metadata and controls

92 lines (71 loc) · 3.18 KB
Raw

WouldYouRather Project

This is the react nanodegree project where it is a polling website.

Live Demo

Would You Rather

TL;DR

To get started developing right away:

  • install all project dependencies with npm install
  • start the development server with npm start

What You're Getting

├── README.md - This file.
├── package.json # npm package manager file. It's unlikely that you'll need to modify this.
├── .gitignore # List of files to ignore from git.
├── public
│   ├── favicon.ico # React Icon, You may change if you wish.
│   └── index.html # DO NOT MODIFY
|   └── manifest.json
|   └── 404.html
└── src
    ├── App.js # This is the root of your app. Contains static HTML right now.
    ├── App.test.js # Used for testing. Provided with Create React App. Testing is encouraged, but not required.
    ├── actions # Action creators for the app.
    │   ├── authedUser.js
    │   ├── questions.js
    │   └── shared.js
    |   └── users.js
    ├── components # components for the app.
    │   ├── App.js
    │   ├── Dashboard.js
    │   └── Leaderboard.js
    |   └── Login.js
    |   └── Nav.js
    |   └── NewQuestion.js
    |   └── Question.js
    |   └── QuestionPage.js
    ├── middleware # Middlewares for the app.
    │   ├── index.js
    │   ├── logger.js
    ├── reducers # Reducers for the app.
    │   ├── authedUser.js
    │   ├── questions.js
    │   └── index.js
    |   └── users.js
    ├── utils # Helpers for the app.
    │   ├── _DATA.js
    │   ├── api.js
    │   └── helpers.js
    ├── index.css # Global styles. You probably won't need to change anything here.
    └── index.js # You should not need to modify this file. It is used for DOM rendering only.

Remember that good React design practice is to create new JS files for each component and use import/require statements to include them where they are needed.

Backend Server

To simplify your development process, we've provided a backend server for you to develop against. The provided file utils/_DATA.js contains the methods you will need to perform necessary operations on the backend:

getUsers

Method Signature:

_getUsers()
  • Returns a Promise which resolves to a JSON object containing a collection of users objects.
  • This collection represents the users currently in app.

getQuestions

Method Signature:

_getQuestions()
  • questions: <Object> containing at minimum an id attribute
  • Returns a Promise which resolves to a JSON object containing the Questions in the App.

Create React App

This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.