Skip to content

Commit

Permalink
📖 DOC: Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
justEhmadSaeed committed Sep 4, 2021
1 parent cf2d84b commit b0fb9dd
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 136 deletions.
1 change: 0 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"prettier.singleQuote": true,
"prettier.useTabs": true,
"prettier.semi": false,
"javascript.preferences.quoteStyle": "single",

}
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,19 @@ Take a look at the live <a href="https://quizdom-app.herokuapp.com/" target="_bl

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

## 🚀 Configuration Guidlelines

## ✨Functional Requirements

- ### Teacher

- The teacher should be able to create quizzes.
- The teacher should be able to control the access to quizzes.
- The teacher should be able to copy and share the quiz - code.
- The teacher should be able to view/ delete the responses.
- Create an account on firebase.google.com and add the API key in the src/firebase/firebase.js file.
- Add the MongoDB API key (either 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.

- ### Student
## Supported Environments

- The student should be able to attempt a quiz by using the quiz code.
- The student should be able to attempt the quiz using voice recognition.
- The student should be able to see their scores in the attempted quizzes.
- Windows/ macOS/ Linux operating systems are supported for the development of the respective project.

## Blind Quiz Commands

Expand All @@ -42,16 +40,19 @@ Take a look at the live <a href="https://quizdom-app.herokuapp.com/" target="_bl
- `Repeat Current Question`: To repeat the current Question.
- `submit quiz`: to submit the quiz.

## 🚀 Configuration Guidlelines
## ✨Functional Requirements

- Create an account on firebase.google.com and add the API key in the src/firebase/firebase.js file.
- Add the MongoDB API key (either 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.
- ### Teacher

- The teacher should be able to create quizzes.
- The teacher should be able to control the access to quizzes.
- The teacher should be able to copy and share the quiz code.
- The teacher should be able to view the responses.

- ### Student

- The student should be able to attempt a quiz by using the quiz code.
- The student should be able to attempt the quiz using voice recognition.
- The student should be able to see their scores in the attempted quizzes.

## Supported Environments

- Windows/ macOS/ Linux operating systems are supported for the development of the respective project.
8 changes: 0 additions & 8 deletions src/App.test.js

This file was deleted.

72 changes: 0 additions & 72 deletions src/Data.json

This file was deleted.

8 changes: 1 addition & 7 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import ReactDOM from "react-dom";
import "./index.css";
import App from "./App";
import { BrowserRouter } from "react-router-dom";
import reportWebVitals from "./reportWebVitals";

ReactDOM.render(
<BrowserRouter>
Expand All @@ -12,9 +11,4 @@ ReactDOM.render(
</React.StrictMode>
</BrowserRouter>,
document.getElementById("root")
);

// If you want to start measuring performance in your app, pass a function
// to log results (for example: reportWebVitals(console.log))
// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
reportWebVitals();
);
7 changes: 0 additions & 7 deletions src/logo.svg

This file was deleted.

13 changes: 0 additions & 13 deletions src/reportWebVitals.js

This file was deleted.

2 changes: 1 addition & 1 deletion src/screens/CreateQuiz.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const CreateQuiz = ({
id='quiz-title'
placeholder='Untitled Quiz'
autoFocus
autocomplete='off'
autoComplete='off'
/>
</div>
<div className='controls'>
Expand Down
5 changes: 0 additions & 5 deletions src/setupTests.js

This file was deleted.

0 comments on commit b0fb9dd

Please sign in to comment.