riteshsoni123 / poll-client

Getting Started with Project

Live Link:

Go to the given link to see the live web app.

https://live2poll.netlify.app/

Steps to run the web app on Local system:

Frontend setup:

Step 1: Go to the given link to download the frontend part of the code.

https://github.com/riteshsoni123/poll-client

Step 2: After downloading the code go inside the directory and type the command "npm install" in the console to download all the packages used in the frontend. Step 3: Now to run the frontend part some essentential details is needed which is stored in the .env file. Step 4: Create an .env file in the directory and paste the following information in it.

REACT_APP_BACKEND_URL=http://localhost:8000

Step 5: Type the "npm start" command in the console to start the frontend. After this the frontend part is ready to be executed in the local system.

Backend setup:

Step 1: Go the the given link to download the backend part of the code.

https://github.com/riteshsoni123/poll-server

Step 2: After downloading the code go inside the directory and type the command "npm install" in the consile to downlead all the packages used in the backend. Step 3: Now to run the backend part some essential details is needed which is stored in the .env file. Step 4: Create an .env file in the directory and paste the following information in it.

FRONTEND_URL=http://localhost:3000

Step 5: Type the "npm start" command in the cosole to start the frontend. After this the backend part is ready to be executed in the local system.

Local link

Use the given link to view the app.

http://localhost:3000

How to use the web application

Login for Teacher and student

The Teacher will have to select the profession from the dropdown box provided in the login page. After that write the name of the person trying to enter the site.

Below is the login example for the teacher and student.

Join room for teacher and student.

After login the teacher will be redirected to the below screen where he/she have to click the "Create Room" button on the right hand side of the navbar. After the button is clicked a room is created and teacher will be inside in the room.

Now as you can see the Room Id is displayed on the right side of the navbar where previously was the "Create Room" button.

Now for student to join the room he/she have to copy the Room Id displayed on the teacher screen and paste it in the input field and click the "join" button that is on the right side of the navbar.

Now as you can see the Room Id is displayed on the right side of the navbar where previously was the input field and the "Join" button.

Create Poll

Now to create a poll the teacher has to click the "Create New Poll" button on the screen.

A form will appear where you can enter the question and the time limit for the poll to last. With the help of the "Add Options" button you can add extra options for the poll. After everything done click on the "submit" to start the poll.

This is the screen that will appear on the student side so that they can answer and submit the poll. They will also be allowed to see the live poll after submission.