quizDaddy

Table of Contents

• Introduction
• Technologies Used
• Installation
• Usage
• Contributing
• Screenshots
• About Page
• Log In Page
• Features Page
• Flashcards & Quizzes Page
• Revision Schedule Page
• Profile Page

Introduction

quizDaddy is a web application for students to upload their notes and materials to generate flashcards and quizzes using ChatGPT API for their enhanced learning. Empowered by our spaced repetition algorithm, revision is structured and maximised for upcoming exams.

Technologies Used

• React
• axios
• pdfjs-dist

Installation

1. Clone the repository:

   git clone https://github.com/HEAPS-ACTUAL/frontend.git
   

   Make sure you are in the frontend directory

2. Install the dependencies:

   npm install

Usage

1. Start the frontend server:

     npm start

Contributing

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature-name)
3. Make your changes
4. Commit your changes (git commit -m 'Add some feature')
5. Push to the branch (git push origin feature/your-feature-name)
6. Open a Pull Request

Screenshots

About Page

Log In Page

Features Page

Flashcards & Quizzes Page

Revision Schedule Page

Profile Page