Skip to content

ankitsharma-at/teachmeAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 

Repository files navigation

📚 TeachMe: AI-Powered Learning Assistant

🌟 Project Overview

TeachMe is an innovative web application that leverages AI to transform how students interact with academic content. Developed by students from Manikya Lal Verma Textile & Engineering College, this project aims to simplify learning through intelligent document processing and knowledge assessment.

🎯 Problem Statement

Addressing the challenges students face when studying large volumes of text by creating an AI-driven platform that:

  • Summarizes academic content
  • Enables intelligent Q&A interactions
  • Provides knowledge evaluation through quizzes

📊 System Architecture

flowchart TD
    A[User] --> B[Frontend: React.js]
    B --> |PDF Upload| C[Text Extraction\nreact-pdftotext]
    C --> D[Backend: Node.js/Express.js]
    D --> |Process Text| E[Gemini AI Model]
    E --> |Generate| F[Document Summary]
    E --> |Create| G[Interactive Quiz]
    F --> H[Display Summary]
    G --> I[Quiz Interface]
    I --> |User Answers| J[Performance Evaluation]
    J --> K[Personalized Feedback]
Loading

✨ Key Features

  • 📄 PDF Document Processing
  • 🤖 AI-Powered Summarization
  • ❓ Intelligent Q&A Interface
  • 🧠 Dynamic Quiz Generation
  • 📊 Personalized Performance Feedback

🛠 Technologies Stack

Frontend

  • React.js
  • Tailwind CSS
  • react-pdftotext
  • MARKDOWNRENDER library

Backend

  • Node.js
  • Express.js

AI Integration

  • Gemini Large Language Model (LLM)

🔧 Component Interaction

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant GeminiAI
    
    User->>Frontend: Upload PDF
    Frontend->>Backend: Send Extracted Text
    Backend->>GeminiAI: Process Document
    GeminiAI-->>Backend: Generate Summary
    GeminiAI-->>Backend: Create Quiz Questions
    Backend-->>Frontend: Return Results
    Frontend->>User: Display Summary & Quiz
Loading

🚀 Development Journey

Challenges Overcome

  1. Complex PDF Text Extraction
  2. AI Response Formatting
  3. Dynamic Quiz Generation

Strategy

  1. Requirement Analysis
  2. Technology Selection
  3. Modular Development
  4. Continuous Testing and Optimization

🔍 Performance Metrics

pie title User Engagement Metrics
    "Improved Learning Efficiency" : 40
    "Interactive Q&A Sessions" : 30
    "Personalized Feedback" : 20
    "Quiz Performance Tracking" : 10
Loading

👥 Team

  • Ankit Sharma (CSE, 2nd Year)
  • Aditya Maheshwari (CSE, 2nd Year)
  • Kishori Arora (CSE, 2nd Year)

📦 Installation

Prerequisites

  • Node.js
  • npm

Steps

  1. Clone the repository
    git clone https://github.com/your-username/teachme.git
  2. Install dependencies
    cd teachme
    npm install
  3. Start the application
    npm start

🔒 License

This project is part of CreateX 2024 innovation challenge.

🌈 Future Roadmap

  • Multi-language Support
  • Enhanced AI Models
  • More Sophisticated Quiz Algorithms
  • User Performance Analytics

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •