QuizHut v1.0

🔗 You can check out our project live here : https://quizhut.herokuapp.com/

About

The website was built using ReactJS & Bootstrap 4.0, and it uses Google Firebase's Firestore as a back-end to store and serve data dynamically.

Short Description

• Users can sign up and create an acount by providing the required credentials.
• Upon signing in, the users can create a quiz, or take a quiz created by others by using a unique quiz ID generated from the creation of another quiz.
• Users can also view & export reports for the quizzes they have set.
• Users can check their past quiz scores in their profile.

Running in Localhost

Installation - Windows, Linux and Mac

Clone the repository

git clone https://github.com/svishakan/OOAD-Project.git

Move to the app directory

cd OOAD-Project/quiz-app/

Add .env file in quiz-app/

1. Fill the empty ENV.txt with the API keys obtained from the following:
2. Create a Project in https://console.firebase.google.com/
3. Obtain the enviroinment varibles for your project - Reference Here
4. Create an account in EmailJS.com
5. Obtain the enviroinment Variables for EmailJS - Reference Here
6. Add a HMAC key to your file.
7. Store the the now filled ENV.text as a .env file in the same directory.

Install the dependencies required for running this project

npm install

Start the project

npm start

The App should be open in your browser now. If not, then paste this in your browser

localhost:<PORT>/

The port for React-App is generally 3000, if not, check your terminal and use the port number specified there.

Documentation

The Software Documentation of the project consists of different UML diagrams that explain and illustrate the design and thought process that went behind the implementation of this project.

Features

Basic Authentication

Login To An Existing Account 🔑

Create An Account 🔐

Take Up A Quiz 📚

Create A New Quiz 📝

View Quiz Reports ✅

Other Features ✨

Author Notes 👓

Kindly show us some ❤️ by ⭐ing this repository! Thanks! The project is also open to contributions from others, so if you're interested, you can get in touch with us! 😃

Icon Credits 📎

QuizHut Logo made by Freepik from Flaticon.com.