Giter Club home page Giter Club logo

svishakan / ooad-project Goto Github PK

View Code? Open in Web Editor NEW
29.0 1.0 2.0 17.66 MB

Contains documentation & code related to the project done by my team for the Object Oriented Analysis and Design laboratory course of my college.

Home Page: https://quizhut.herokuapp.com/

License: GNU General Public License v3.0

HTML 1.20% CSS 20.98% JavaScript 77.82%
reactjs css3 bootstrap4 react-bootstrap hmac-sha256 authentication quiz javascript uml-diagrams class-diagram

ooad-project's Introduction

QuizHut v1.0

alt QuizHutLogo

πŸ”— You can check out our project live here : https://quizhut.herokuapp.com/


Stars License Forks Issues Repo Size Website


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

alt Instruction

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 πŸ”‘

alt Take up a Quiz GIF

Create An Account πŸ”

alt Take up a Quiz GIF

Take Up A Quiz πŸ“š

alt Take up a Quiz GIF

Create A New Quiz πŸ“

alt Take up a Quiz GIF

View Quiz Reports βœ…

alt Take up a Quiz GIF

Other Features ✨

alt Take up a Quiz GIF

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.

ooad-project's People

Contributors

svishakan avatar venkataraman-nagarajan avatar vikramvenkatapathi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.