Skip to content

suny1000/NeuroLearn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

3 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

NeuroLearn - AI Tutor for Every Brain

๐ŸŒŸ LIVE DEMO

๐Ÿ”— Access the complete MVP: https://ppl-ai-code-interpreter-files.s3.amazonaws.com/web/direct-files/36ee776f5701084e820f0722100ac08a/6dfb71e8-18af-4ce3-b2b8-1ab21cbd3c49/index.html


๐ŸŽฏ Vision

NeuroLearn revolutionizes education by providing an adaptive, AI-powered learning platform that truly understands every brain. Our mission is to make quality education accessible, inclusive, and personalized for students of all learning styles and abilities.


โœจ Key Features

๐Ÿ  Stunning Homepage

  • Apple/Dribbble-level design with animated hero section
  • Feature showcase with beautiful cards and illustrations
  • Interactive statistics counter and testimonials
  • Responsive design with smooth animations

๐Ÿ” Complete Authentication System

  • Role-based access (Student/Teacher/Admin)
  • One-click demo login functionality
  • Password validation and secure routing
  • Beautiful form design with error handling

๐ŸŽ“ Student Experience

  • Personalized Dashboard with learning analytics
  • AI Tutor Chat with voice input/output capabilities
  • Gamification System with XP, badges, and leaderboards
  • Interactive Quizzes with instant feedback
  • Subject Cards styled as planets with progress tracking

๐Ÿ‘จโ€๐Ÿซ Teacher Dashboard

  • Class management with student progress visualization
  • AI-powered assignment suggestions
  • Performance analytics and heatmaps
  • Student messaging system

๐Ÿ”ง Admin Panel

  • User management and role promotion
  • Platform statistics and system health
  • Demo account impersonation
  • Content management interface

โ™ฟ Accessibility Features

  • Dyslexia-friendly font toggle (OpenDyslexic)
  • Text-to-speech for all content (Web Speech API)
  • Speech-to-text input capabilities
  • High contrast mode and adjustable text sizes
  • Keyboard navigation and screen reader support

๐Ÿค– AI Integration

  • HuggingFace Inference API integration (free tier)
  • Intelligent fallback to realistic mock responses
  • Subject-specific tutoring across Math, Science, History, English
  • Structured responses with explanations and examples

๐Ÿš€ Demo Credentials

Quick Access (One-Click Login):

  • Student Demo: DemoStudent / DemoPass123
  • Teacher Demo: DemoTeacher / DemoPass123
  • Admin Demo: DemoAdmin / DemoPass123

Individual Accounts:

Students:

Teachers:

Admins:


๐Ÿ› ๏ธ Technology Stack

Frontend

  • React 18 - Modern functional components with hooks
  • React Router - Client-side routing with protected routes
  • Lucide React - Beautiful icon system
  • Web Speech API - Native browser text-to-speech and speech-to-text
  • CSS Variables - Comprehensive design system with dark/light themes
  • Chart.js - Data visualization for analytics

AI & APIs

  • HuggingFace Inference API - Free tier AI responses
  • Intelligent Fallback System - Mock responses when API unavailable
  • Rate Limiting - Request queue management

Data & State

  • Context API - Global state management
  • LocalStorage - Persistent demo data
  • JSON Data Structure - Comprehensive demo dataset

Design & Accessibility

  • Inter Font Family - Professional typography
  • 8px Grid System - Consistent spacing
  • ARIA Labels - Screen reader compatibility
  • Focus Management - Keyboard navigation
  • Color Contrast Compliance - WCAG guidelines

๐Ÿ“ฑ Responsive Design

  • Mobile-First Approach (320px+)
  • Tablet Optimization (768px+)
  • Desktop Experience (1024px+)
  • Touch-friendly interfaces and gestures

๐Ÿ”ง Setup & Installation

Local Development

# Clone the repository
git clone <repository-url>
cd neurolearn-mvp

# Open index.html in your browser
# Or use a local server:
npx serve .
# or
python -m http.server 8000

Production Deployment

Frontend (Vercel):

# Deploy to Vercel
vercel deploy

# Or use Netlify
netlify deploy --prod --dir=dist

Backend Options (if extending):

# Render
render deploy

# Heroku
heroku create neurolearn-api
git push heroku main

๐Ÿง  AI Configuration

Using Real HuggingFace API:

  1. Sign up at HuggingFace
  2. Create a free API token
  3. Replace YOUR_HF_TOKEN in the AI service configuration
  4. Free tier includes 300 requests/hour

Mock Mode (Default):

  • Realistic AI responses for all subjects
  • No API key required
  • Perfect for demos and development

๐ŸŽฎ Gamification System

XP Points System:

  • Complete Lesson: +30 XP
  • Finish Quiz: +50 XP
  • Chat with AI Tutor: +10 XP
  • Daily Streak Bonus: +20 XP

Badge Categories:

  • Achievement Badges: First Steps, Quiz Champion
  • Subject Mastery: Math Master, Science Explorer, Language Expert
  • Streak Badges: 7-Day Streak, 12-Day Streak
  • Special Badges: Accessibility Hero, Art Lover

Leaderboard:

  • Real-time XP tracking
  • Level progression system
  • Peer comparison and motivation

โ™ฟ Accessibility Features

Visual Accessibility:

  • Dyslexia-friendly OpenDyslexic font
  • High contrast mode toggle
  • Adjustable text sizes (Small/Medium/Large)
  • Clear focus indicators

Audio Accessibility:

  • Text-to-speech for all content
  • Speech-to-text input for AI chat
  • Audio feedback for interactions

Navigation Accessibility:

  • Full keyboard navigation
  • Skip navigation links
  • Semantic HTML structure
  • ARIA labels and descriptions

๐Ÿ“Š Analytics & Performance

Student Analytics:

  • Learning time tracking
  • Subject progress monitoring
  • Achievement unlocks
  • Engagement metrics

Teacher Analytics:

  • Class performance overview
  • Individual student progress
  • Assignment completion rates
  • Time-on-task metrics

Platform Analytics:

  • User growth statistics
  • Feature usage patterns
  • Performance optimization data

๐Ÿ”ฎ Future Enhancements

Phase 1 (Short Term):

  • Real-time collaboration features
  • Advanced quiz question generation
  • Mobile app development (React Native)
  • Parent dashboard portal

Phase 2 (Medium Term):

  • Video lesson integration
  • Peer-to-peer learning
  • Advanced AI tutoring with GPT-4
  • Multi-language support

Phase 3 (Long Term):

  • VR/AR learning experiences
  • Blockchain-based achievement verification
  • Advanced learning analytics with ML
  • Global classroom connections

๐Ÿ‘จโ€๐Ÿ’ป Developer

Suresh Bishnoi - Founder & Lead Developer


๐Ÿ“„ License

This project is developed as an educational MVP and is available for learning and demonstration purposes.


๐Ÿ™ Acknowledgments

  • HuggingFace for providing free AI inference
  • Web Speech API for browser-based voice capabilities
  • React community for excellent documentation and tools
  • Accessibility community for inclusive design guidelines

๐Ÿ“ž Support

For questions, suggestions, or collaboration opportunities:

  • Email: [email protected]
  • GitHub Issues: Open an issue for bug reports
  • Community: Join our Discord for discussions

Experience the future of education - where every brain can thrive! ๐Ÿง โœจ

About

Education Built for Every Brain, Everywhere

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors