Tutorific.AI

Tutorific.AI is a robust educational assistant platform tailored to support students in their learning journey. Offering personalized tutoring, flashcards, writing assistance, and customizable quizzes on any topic, Tutorific.AI makes studying more engaging with an intuitive UI, interactive elements, and smooth transitions to elevate the user experience.

Note: This project won third place in HackPSU Fall 2024!

Important:

To secure your own API key, please store it in a .env file as previous commits with exposed keys have been removed.

Video Demo:

Watch the video demo here!

---

Table of Contents

• Features
• Installation
• Usage
• Contributing
• License

---

Features

Interactive Homepage

• Four main sections: Tutor, Flash Cards, Writer, and Quiz, each with distinct icons and colors.
• Smooth zoom-in animations on click for a user-friendly, visually engaging experience.

Tutor

• Q&A Support: Get detailed explanations, problem-solving help, and insights on complex topics.
• Tailored Feedback: Every response is customized to aid understanding and promote independent learning.

Flash Cards

• Flashcard Creation: Organize essential concepts and lecture materials into flashcards for easier revision.
• In-depth Review: Flashcards emphasize core details and provide comprehensive information for effective studying.

Writer

• Content Generation: Create structured essays, reports, or creative writing pieces.
• Paraphrasing & Grammar: Rewrite text for clarity or refine grammar and style.
• Humanizing AI Text: Adapt AI-generated text to sound more conversational and natural.

Quiz

• Customizable Quizzes: Generate topic-specific quizzes with options for:
  • Multiple Choice: Choose the correct answer from multiple options.
  • True/False: Select between two answer choices.
  • Short Answer: Type in open-ended responses.
  • Mixed Mode: Enjoy a mix of all question types.
• Instant Feedback: Get immediate scoring and answer summaries after each quiz.
• Reset Function: Quickly clear the quiz content using the trash icon.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/Tutorific.git
   

2. Navigate to the project directory:

   cd Tutorific

3. Install dependencies:

   npm install

Usage

1. Start the development server:

   npm start

2. Open your browser and navigate to http://localhost:3000 to start using the app.
3. Choose a section on the homepage and begin exploring its features.

Contributing

Contributions are welcome! Feel free to submit issues, fork the repository, and open pull requests.

License

This project is licensed under the MIT License.

---