Kemsty2 / would-you-rather

Udacity React NanoDegree Project N°2

Introduction

Would You Rather is the project N°2 i realized for the React Nanodegree Course. Please note that this package is still under active MIT License.

Table of Contents

• Introduction
• Table of Contents
  • Requirements
  • Features
  • Installation
  • Usage
  • Documentation
    • Poll Item
    • LogIn into the application
    • List the poll
    • Add a poll
    • Answer a poll
    • See Poll Details
    • Display Leaderboard
  • Credits
  • License

Requirements

Make sure your computer meets the following requirements.

• Node > 10.x
• Yarn > 1.21.x
• Firefox or Google Chrome Navigator

Features

We have few features :

• List the polls
• Answer a poll
• See details of a poll
• Create a Poll
• Login on the application
• See Leaderboard

Installation

Firstly, download the project using :

$git clone https://github.com/kemsty2/woudl-you-rather

Install all the dependecies of the client app :

$cd Frontend
$yarn install

This command will install all the required dependecies to run the react client application.

Usage

Run webpack live server

$yarn start

To view the application, go to:

http://localhost:3000/

Documentation

Poll Item

The application is able to manage poll. A poll item contains the following field :

• id (string) - a unique id for a poll
• author (string) - a id which represent the poll author
• timestamp (int) - which represent the creation date of the poll
• optionOne (object) - information about the option One. Number of votes and the text
• optionTwo (object) - information about the option One. Number of votes and the text

LogIn into the application

First, the user should login to the platform. To log into the platform, select a user in the user list and click on Sign In

List the poll

After logging on the application, the list of poll is displayed. You can

1. Filter the poll between Unanswered and Answered Poll

Add a poll

To add a poll, Click on Add Poll Nav Link.

1. Edit the optionOne and optionTwo
2. Click on Add

Answer a poll

To answer a poll,

1. Click on a poll
2. Select your option
3. Click on submit

The Poll Details is displayed.

See Poll Details

Click on an answered poll

1. The Details of a poll is displayed

Display Leaderboard

To display a leaderboard, click on Leaderboard Nav Item

Credits

• Kemgne Moyo Steeve Aymard

License

MIT. Please see the license file for more information.