Skip to content

smdhussain06/AttiTutor

Repository files navigation

๐ŸŽ“ Atti Tutor

Learn anything through stories about your friends - A revolutionary AI-powered educational app with Apple-inspired design that transforms complex topics into memorable, personalized learning experiences.

โœจ Features

๐Ÿค– Advanced AI Integration

  • OpenRouter Qwen AI - Powered by cutting-edge Qwen-2.5-72B model
  • Academic-Grade Definitions - Anna University style formal definitions
  • 5th Grade Explanations - Complex concepts broken down from scratch
  • Structured Learning - Logical, step-by-step conceptual building
  • Memory Aids - Emojis, rhymes, and recall techniques
  • Comprehensive Responses - Up to 2000 tokens for detailed explanations
  • API Management System - Easy key switching, error recovery, and troubleshooting
  • Smart Error Handling - Automatic detection and user-friendly recovery options

๐Ÿ‘ฅ Friendship-Based Learning

  • Personalized Stories - Uses your friends' personalities and memories
  • Relatable Analogies - Creates authentic scenarios with friend involvement
  • Character-Driven Education - Friends become teachers in your stories
  • Emotional Connection - Makes learning memorable through relationships

๐ŸŽ Apple-Inspired Design

  • Flat Color System - Clean iOS colors without gradients for modern aesthetic
  • Glassmorphism UI - Frosted glass effects with backdrop blur on main container
  • SF Pro Typography - Apple's signature font family
  • iOS Color Palette - Native blue, green, orange, and red flat colors
  • Smooth Animations - 0.3s ease transitions with hover effects
  • Touch-Optimized - 32px+ tap targets for mobile interaction
  • Responsive Design - Seamless experience across all devices
  • Modal System - Professional overlay interactions for API management

๐Ÿ”’ Privacy & Security

  • Local Storage - API keys stored securely in browser
  • No Data Collection - Your conversations stay private
  • Transparent Usage - Clear API key requirements and usage
  • Key Management - Easy switching, removal, and troubleshooting tools
  • Error Recovery - Graceful handling of API issues with user guidance

๐Ÿš€ Live Demo

Try Atti Tutor Live

Experience the full AI-powered learning with your own OpenRouter API key!

๐Ÿ”‘ Quick Setup for AI Features

Get Your Free OpenRouter API Key:

  1. Visit OpenRouter.ai - Universal AI API platform
  2. Create Account - Sign up for free (no credit card required initially)
  3. Generate API Key - Create a new API key in your dashboard
  4. Add to App - Enter your key in the app's secure form
  5. Start Learning - Generate unlimited personalized educational stories!

Why OpenRouter + Qwen?

  • ๐Ÿ†“ Free credits to get started
  • ๐Ÿง  Qwen-2.5-72B - One of the most advanced AI models
  • ๐Ÿ“š Academic Focus - Excellent for educational content
  • ๐ŸŒ Multilingual - Supports learning in multiple languages
  • โšก Fast Response - Optimized for real-time learning experiences

๐Ÿ’ป Tech Stack

Frontend

  • React 18 - Modern hooks-based architecture
  • CDN Deployment - Bypass build issues with direct React loading
  • Babel Standalone - Real-time JSX transpilation
  • CSS3 - Advanced animations and glassmorphism effects

AI Integration

  • OpenRouter API - Universal AI model access
  • Qwen-2.5-72B-Instruct - Advanced language understanding
  • Structured Prompting - Educational format optimization
  • Error Handling - Graceful fallbacks and user feedback

Design System

  • Apple Human Interface - Following iOS design principles
  • Responsive Grid - CSS Grid with auto-fit columns
  • Variable Fonts - SF Pro Display with proper letter spacing
  • Color Science - Accessible contrast ratios and semantic colors

๐ŸŽจ Design Philosophy

Apple-Inspired Aesthetics

/* Core Design Principles */
- Flat Colors: Pure iOS colors (#007AFF, #30D158, #FF9500, #FF3B30)
- Glassmorphism: backdrop-filter: blur(20px) on main container
- Typography: -apple-system, BlinkMacSystemFont, 'SF Pro Display'
- Spacing: Generous padding (2.5rem, 3rem) for breathing room
- Corners: Consistent 12px-20px border radius
- Shadows: Layered shadows for depth (0 10px 40px + 0 1px 3px)
- Performance: No gradients for faster rendering

Interaction Design

  • Hover States - Subtle lifts and shadow expansion
  • Focus States - Blue glow rings for accessibility
  • Loading States - Engaging animations during AI processing
  • Touch Feedback - Immediate visual response to interactions

๐Ÿ› ๏ธ Getting Started

Prerequisites

  • Modern web browser (Chrome, Safari, Firefox, Edge)
  • OpenRouter API key for AI features
  • Internet connection for CDN resources

Local Development

  1. Clone the repository

    git clone https://github.com/smdhussain06/AttiTutor.git
    cd AttiTutor
  2. Install dependencies

    npm install
  3. Start development server

    npm run dev
  4. Open in browser Navigate to http://localhost:5173

Deployment Options

GitHub Pages (Current)

  • Direct HTML serving from main branch
  • No build process required
  • CDN-based React loading

Alternative Deployment

# For traditional build deployment
npm run build
npm run preview

๏ฟฝ AI Prompt Engineering

Structured Educational Format

The app uses advanced prompt engineering for optimal learning:

๐Ÿ“– Official Definition: [Academic-grade definition]
๐ŸŽฏ Simple Explanation: [5th grade breakdown]
๐Ÿ“š Step-by-Step Concepts: [Logical building blocks]
๐Ÿ‘ฅ Friend Story: [Personalized narrative]
๐Ÿง  Memory Hooks: [Recall techniques]
โœ… Quick Recap: [Reinforcement summary]

Quality Optimization

  • 2000 token limit for comprehensive responses
  • Temperature 0.7 for creative yet focused content
  • Structured formatting with markdown and emojis
  • Error handling with meaningful user feedback

๐Ÿ“ฑ Usage Guide

Step 1: Setup

  1. Open the app and enter your OpenRouter API key
  2. Key is securely stored in browser localStorage
  3. No server-side storage or data collection
  4. Use API Info button to check connection status
  5. Change Key anytime if needed or experiencing issues

Step 2: Add Friends

  1. Click "+ Add Friend" to add learning companions
  2. Enter friend's name and a memorable trait/personality
  3. Friends become characters in your educational stories

Step 3: Learn

  1. Enter any topic you want to learn about
  2. Click "Create My Learning Story! ๐Ÿ“š"
  3. Receive a comprehensive, personalized explanation

API Management Features

  • โ„น๏ธ API Info - View connection status, key details, and troubleshooting tips
  • ๐Ÿ”„ Change Key - Switch API keys easily without losing progress
  • ๐Ÿšจ Error Recovery - Automatic detection of API issues with recovery options
  • ๐Ÿ—‘๏ธ Remove Key - Start fresh with a new API key
  • ๐Ÿ“Š Status Display - Visual indicators for API health and connection state

Example Learning Session

Topic: "Photosynthesis"
Friends: 
- Alex (loves gardening)
- Sam (always asks why things work)

Result: A detailed story where Alex and Sam discover 
photosynthesis in Alex's garden, complete with:
- University-level definition
- Simple analogies
- Step-by-step process
- Memorable phrases with emojis
- Real-world connections

๐ŸŽฏ Educational Impact

Learning Science Integration

  • Narrative Learning - Stories improve retention by 65%
  • Social Context - Friend involvement increases engagement
  • Multi-Modal - Visual (emojis) + textual learning
  • Scaffolded Difficulty - 5th grade โ†’ Academic progression
  • Active Recall - Memory hooks promote long-term retention

Academic Applications

  • University Preparation - Anna University style definitions
  • Concept Clarification - Breaking down complex topics
  • Exam Preparation - Memorable formats for recall
  • Cross-Subject Learning - Works for any academic field

๐Ÿ”ฎ Future Enhancements

Version 2.0 Roadmap

  • Voice Integration - Text-to-speech for stories
  • Visual Learning - AI-generated diagrams and illustrations
  • Study Groups - Share friends and stories with classmates
  • Progress Tracking - Learning analytics and achievement system
  • Offline Mode - Cached stories for offline review
  • API Provider Options - Support for multiple AI providers
  • Advanced Error Recovery - Automatic retry and fallback systems

Advanced Features

  • Multi-Language - Learn in your preferred language
  • Difficulty Adaptation - AI adjusts complexity based on feedback
  • Knowledge Graphs - Connect related topics automatically
  • Export Options - PDF, flashcards, and study guides

๐Ÿค Contributing

We welcome contributions to make learning more accessible and engaging!

Development Setup

# Fork and clone
git clone https://github.com/yourusername/AttiTutor.git
cd AttiTutor

# Create feature branch
git checkout -b feature/amazing-feature

# Make changes and test locally
npm run dev

# Commit with conventional commits
git commit -m "feat: add amazing new feature"

# Push and create PR
git push origin feature/amazing-feature

Contribution Areas

  • UI/UX improvements
  • Educational prompt optimization
  • Performance enhancements
  • Accessibility improvements
  • Mobile experience refinements
  • API management and error handling
  • New AI provider integrations

๐Ÿ“„ License

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

๐Ÿ™ Acknowledgments

  • Apple Inc. - Design inspiration from iOS and macOS
  • OpenRouter - Universal AI API platform
  • Alibaba DAMO - Qwen AI model development
  • Educational Research - Learning science principles integration
  • Open Source Community - React, Vite, and web technologies

Made with โค๏ธ for transforming education through friendship and AI

"The best way to learn is through stories, and the best stories involve the people we care about." - Atti Tutor Philosophy

About

AttiTutor is your fun last-minute study buddy! ๐Ÿค“๐Ÿ’ฅ It explains topics using your notes + your friends' quirks, making learning feel like a chill group study sesh. Built with HTML, CSS & JS. Exams just got personal (and way more fun)! ๐ŸŽ‰๐Ÿ“š

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors