Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #8

Merged
merged 2 commits into from
Oct 7, 2022
Merged

Update readme #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fad3745
doc: update readme
justEhmadSaeed Oct 7, 2022
8f80610
Merge branch 'master' of github.com:justEhmadSaeed/quizdom into bug-f…
justEhmadSaeed Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,38 @@

## 🎓Overview

QUIZDOM is a web application for all kinds of users. Users can simply log in to be able to create and join quizzes via sharing the quiz code. There might be lots of quiz generating applications, but the idea of creating a quiz and then taking it on the same platform and evaluating the students in such an amazingly easier way is quite innovative, where a teacher will create a quiz and have control over its shareability and access. Upon enabling public access, the app will provide a unique and secure quiz code that can be shared with students. Quiz code will be used by students to join the quiz and to avoid anonymous spamming entries. A list of students and their marks in respective quizzes will be shared with the creator/ teacher of the quiz.
QUIZDOM is a web application for all kinds of users. Users can simply log in to be able to create and join quizzes by sharing the quiz code. There might be lots of quiz-generating applications, but the idea of creating a quiz and then taking it on the same platform and evaluating the students in such an amazingly easier way is quite innovative, where a teacher will create a quiz and have control over its shareability and access. Upon enabling public access, the app will provide a unique and secure quiz code that can be shared with students. Quiz code will be used by students to join the quiz and to avoid anonymous spamming entries. A list of students and their marks in respective quizzes will be shared with the creator/ teacher of the quiz.

## ⏯ Preview

Take a look at the live <a href="https://quizdom-app.herokuapp.com/" target="_blank">Preview of the app.</a>.

![Quizdom Demo](https://user-images.githubusercontent.com/46846821/113098567-12f45080-9212-11eb-84f4-a4e9092453e1.gif)

## 🚀 Configuration Guidlelines
## 🚀 Configuration Guidelines

- Create an account on firebase.google.com and add the API key in the .env file.
- Add the MongoDB API key (either local server key or from the Atlas MongoDB remote server) in backend/src/server.js.
- Add the MongoDB API key (either the local server key or from the Atlas MongoDB remote server) in backend/src/server.js.
- Install MongoDB Server if you want to use the database locally.
- Install Node.js to use npm and node services.
- Open a terminal with the path set to the root directory of the project and run `npm install` command to install the required packages.
- Open a new terminal with the path set to the backend directory of the project and run `npm install` command to install the required packages.
- After successful installation of all packages, run command `npm start` in the terminal with the path set to the root directory and wait for the project to initiate.
- After successful installation of all packages, run the command `npm start` in the terminal with the path set to the root directory and wait for the project to initiate.

## Supported Environments

- Windows/ macOS/ Linux operating systems are supported for the development of the respective project.

## Blind Quiz Commands

- The Blind Quiz Module works with the limited Speech Commands to interact with the App.
- The Blind Quiz Module works with limited Speech Commands to interact with the App.
- Press `space` to turn the microphone on.
- Voice Commands:
- `Instructions`: To listen to all the possible commands.
- `start Quiz` or `title`: To listen the Quiz title and first Question.
- `start Quiz` or `title`: To hear the Quiz title and first Question.
- `Select Option [Number]` or `Choose Option [Number]`: To mark the option of the current Question.
- `next question`: to increment the question index and move to the next question and listen it.
- `previous question`: to decrement the question index and move to the previous question and listen it
- `Repeat Question [Number]`: To listen a specific Question.
- `next question`: to increment the question index and move to the next question and listen to it.
- `previous question`: to decrement the question index and move to the previous question and listen to it
- `Repeat Question [Number]`: To hear a specific Question.
- `Repeat Current Question`: To repeat the current Question.
- `submit quiz`: to submit the quiz.