Skip to content

naman-ranka/adaptedge-assignment-helper

Repository files navigation

🧠 AdaptED AI

AI-Powered Adaptive Learning Platform

Hackathon Winner Live Demo MIT License

A smart digital tutor that personalizes learning with real-time help, adaptive feedback, and simplified lessons—making education accessible, engaging, and tailored to you.

Live DemoReport BugRequest Feature


📋 Table of Contents


🎯 Overview

AdaptED AI is a revolutionary AI-powered learning platform designed to transform how students approach assignments and learning. Built with cutting-edge AI technology, it provides personalized, adaptive learning experiences that cater to individual learning styles and pace.

🏆 Hackathon Achievement

This project was developed as a winning submission for a hackathon, showcasing innovation in educational technology and AI integration.

✨ What Makes AdaptED AI Special?

  • Adaptive Learning Paths: Choose from three distinct learning modes based on your needs
  • AI-Powered Insights: Leverages Google's Generative AI (Gemini) for intelligent content analysis
  • Interactive Learning: Engage with dynamic flashcards, quizzes, and progressive assessments
  • Multi-Format Support: Upload various document formats for seamless learning
  • Real-Time Feedback: Get instant, personalized feedback on your progress

🚀 Key Features

📚 Three Learning Modes

Mode Description Status
🎯 Quick Start Basic tutorials and straightforward answers for gentle introduction Coming Soon
⚡ Learn Fast Hints, nudges, and partial answers for grasping basics quickly Coming Soon
🏆 Master It Full tutorials and interactive material for comprehensive knowledge ✅ Available

🔥 Core Features

  • Smart Document Processing

    • Support for .pdf, .doc, .docx, .txt, .rtf, .ppt, .pptx
    • Intelligent content parsing and structuring
    • Automated learning material generation
  • Interactive Learning Tools

    • AI-powered assignment analysis
    • Dynamic flashcard generation
    • Progressive assessment questions
    • Real-time progress tracking
  • Personalized Experience

    • Adaptive difficulty levels
    • Custom learning paths
    • Detailed performance analytics
    • Dark/Light mode support
  • Modern UI/UX

    • Beautiful, responsive design
    • Smooth animations and transitions
    • Glassmorphism effects
    • Mobile-friendly interface

🛠️ Tech Stack

Frontend

Technology Purpose
React UI Framework
TypeScript Type Safety
Vite Build Tool
TailwindCSS Styling
Shadcn UI UI Components

AI & State Management

Technology Purpose
Google AI AI Engine
React Query Data Fetching
Zustand State Management
React Router Routing

Additional Libraries

  • UI Enhancement: Lucide React (icons), Framer Motion (animations)
  • Form Handling: React Hook Form, Zod validation
  • Markdown: React Markdown with syntax highlighting
  • Styling: Class Variance Authority, Tailwind Merge

🎬 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn
  • Google Gemini API Key (Get one here)

Installation

  1. Clone the repository
git clone https://github.com/pranawwwww/adaptedge-assignment-helper.git
cd adaptedge-assignment-helper
  1. Install dependencies
npm install
  1. Set up environment variables

Create a .env file in the root directory:

# Gemini API Key (Required)
VITE_GEMINI_API_KEY=your_gemini_api_key_here

# Development settings (Optional)
VITE_USE_MOCK_DATA=false

# File upload settings (Optional)
VITE_MAX_UPLOAD_SIZE_MB=10
VITE_ALLOWED_FILE_TYPES=.pdf,.doc,.docx,.txt,.rtf,.ppt,.pptx
  1. Start the development server
npm run dev
  1. Open your browser

Navigate to http://localhost:5173 to see the app running!

Building for Production

npm run build

The production-ready files will be in the dist directory.


📖 Usage

1. Choose Your Learning Mode

Select from three learning paths based on your needs:

  • Quick Start: For rapid understanding
  • Learn Fast: For efficient learning
  • Master It: For comprehensive mastery

2. Upload Your Materials

  • Upload your assignment document
  • Optionally add supplementary learning materials
  • Supported formats: PDF, DOC, DOCX, TXT, RTF, PPT, PPTX

3. Learn & Practice

  • Review AI-generated flashcards
  • Progress through adaptive learning levels
  • Take interactive quizzes and assessments

4. Complete Your Assignment

  • Get personalized feedback
  • Track your progress
  • Achieve mastery through guided learning

📁 Project Structure

adaptedge-assignment-helper/
├── public/
│   ├── prompts/          # AI prompt templates for different levels
│   ├── brain-icon.svg    # Application icons
│   └── 404.html          # 404 page
├── src/
│   ├── components/       # React components
│   │   ├── ui/          # Shadcn UI components
│   │   ├── AIThinkingLoader.tsx
│   │   ├── CourseSelection.tsx
│   │   ├── FlashcardItem.tsx
│   │   ├── GuidedLearning.tsx
│   │   └── ...
│   ├── pages/           # Page components
│   │   ├── Index.tsx    # Landing page
│   │   ├── Upload.tsx   # File upload page
│   │   ├── MasterIt.tsx # Learning page
│   │   └── ...
│   ├── hooks/           # Custom React hooks
│   ├── App.tsx          # Main application component
│   └── main.tsx         # Application entry point
├── .env.example         # Environment variables template
├── package.json         # Dependencies and scripts
├── tailwind.config.js   # Tailwind configuration
├── tsconfig.json        # TypeScript configuration
└── vite.config.ts       # Vite configuration

🧠 AI Learning System

AdaptED AI uses a sophisticated 6-level progressive learning system:

Level Focus Description
Level 0 Assignment Overview Initial analysis and breakdown of the assignment
Level 1 Basic Understanding Core concepts and fundamental principles
Level 2 Advanced Understanding Detailed concept exploration and connections
Level 3 Practical Application Real-world applications and examples
Level 4 Expert Implementation Advanced problem-solving techniques
Level 5 Mastery Comprehensive knowledge synthesis and evaluation

Each level adapts to your responses, providing personalized guidance and feedback.


📸 Screenshots

Add screenshots of your application here to showcase its features

Landing Page

[Screenshot Placeholder]

Upload Interface

[Screenshot Placeholder]

Learning Dashboard

[Screenshot Placeholder]

Interactive Flashcards

[Screenshot Placeholder]


🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

👥 Team

Built with ❤️ by a talented team of developers:

Pranav
Pranav Kutralingam
Naman
Naman Ranka
Swati
Swati Kashyap
Chandan
Chandan Nooli

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


🙏 Acknowledgments

  • Google Generative AI for powering our intelligent tutoring system
  • Shadcn UI for the beautiful component library
  • The open-source community for amazing tools and libraries
  • All hackathon organizers and judges

⭐ Star this repository if you find it helpful!

Made with 💜 by the AdaptED AI Team

⬆ Back to Top

About

AI-powered adaptive learning platform — hackathon winner, personalized assignment generation with Gemini

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages