Skip to content

StudyBuddy is an innovative platform designed to simplify and enrich the student learning experience. From exam preparation to interactive learning tools, StudyBuddy provides a comprehensive suite of features tailored for students preparing for entrance tests, board exams, and regular coursework.

License

Notifications You must be signed in to change notification settings

abdullahdotnet/StudyBuddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

StudyBuddy

StudyBuddy is an innovative platform designed to simplify and enrich the student learning experience. From exam preparation to interactive learning tools, StudyBuddy provides a comprehensive suite of features tailored for students preparing for entrance tests, board exams, and regular coursework.

🌟 Features

1. Entrance Test Exam Preparation

  • Focuses on MDCAT, ECAT, and other competitive entrance exams.
  • Key Features:
    • A collection of past papers for practice.
    • Personalized feedback to identify strengths and weaknesses.
    • Recommendations for targeted improvement.

2. YouTube Video Extension

  • Makes learning from YouTube videos more effective with tools like:
    • Screenshots and timestamped notes while watching.
    • AI-powered video summaries for quick revision.
    • A chatbot that answers questions about the video content.
    • Generate and download a PDF containing:
      • Notes
      • Snapshots
      • Summaries
      • Video timestamps for easy navigation.

3. AI-Powered Chatbot

  • Designed to resolve student queries with precision.
  • Covers pre-loaded textbook content for:
    • 9th-12th grades, including Punjab Board and O/A Levels.

4. Board Exam Preparation

  • Provides focused guidance and resources for board exams.
  • Helps students understand key concepts, solve exam-oriented questions, and track their progress.

5. Engagement Features

  • A dedicated community option for:
    • Peer-to-peer learning.
    • Sharing study tips and experiences.
    • Seeking assistance on challenging topics.
      IMG-20241130-WA0015

6. Additional Tools

  • To-Do List: Stay organized and manage tasks effectively.
  • Personal Data Space: A secure place to store and manage study-related content. IMG-20241130-WA0013

πŸ› οΈ Technology Stack

  • Backend: Django
  • Databases:
    • MySQL for the main server-side storage.
    • IndexedDB for client-side, browser-based storage.
  • AI and NLP Technologies:
    • LangChain: Framework for managing workflows and integrating AI components.
    • RAG (Retrieval-Augmented Generation): Combines retrieved knowledge with AI outputs for accurate responses.
    • HuggingFace Embeddings: Enhances text representation and semantic understanding.
    • LLMs with Groq: Powers querying, summarization, and feedback with optimized performance.

πŸš€ Installation

Prerequisites

  • Python 3.9+ and Django installed.
  • A browser supporting Chrome Extensions.

Steps

  1. Clone the repository:
    git clone https://github.com/YourUsername/StudyBuddy.git  
    cd StudyBuddy  
  2. Set up the backend:
    cd Backend
    pip install -r requirements.txt  
    python manage.py migrate  
    python manage.py runserver  
  3. Set up frontend:
    cd Frontend
    npm install
    npm run dev
  4. Install the Chrome extension:
    • Navigate to chrome://extensions.
    • Enable "Developer mode."
    • Click "Load unpacked" and select the Extension folder.

πŸ‘₯ Developers and Supervisors

This platform was developed by a dedicated team of five developers under the guidance of two supervisors.

Developers

Name GitHub Profile LinkedIn Profile
Muhammad Zubair
Muhammad Abdullah Ghazi
Anas Tahir
Etisam Ul Haq
Abdullah Ashfaq

Supervisors

Name LinkedIn Profile
Dr. Kamran Malik
Dr. Waheed Iqbal

πŸ“„ License

The StudyBuddy platform, including its codebase and content, is protected under a restrictive license.

Prohibited Actions:

  1. Copying, modifying, or redistributing the code or content without explicit written permission.
  2. Using this project for commercial purposes without authorization.
  3. Claiming this project or its derivatives as your own.

For further details, please see the LICENSE file.

πŸ§‘β€πŸ’» Contact

For queries or issues, feel free to open an issue in this repository.

About

StudyBuddy is an innovative platform designed to simplify and enrich the student learning experience. From exam preparation to interactive learning tools, StudyBuddy provides a comprehensive suite of features tailored for students preparing for entrance tests, board exams, and regular coursework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published