Grade-Guide is a modern, AI-powered learning platform designed to enhance students' educational experience through interactive features, personalized learning, and smart study tools. Built with Nuxt.js and powered by Google's Gemini AI, it offers a comprehensive suite of learning tools and features.
- Interactive chat interface with AI tutor
- Real-time responses and explanations
- File upload support for contextual learning
- Markdown and code syntax highlighting support
- AI-powered quiz generation based on subject matter
- Customizable difficulty levels
- Support for multiple file uploads
- Detailed explanations for each answer
- Performance tracking and analytics
- Pomodoro timer for focused study sessions
- Task management system
- Motivational quotes
- Session summaries and productivity tracking
- Real-time group chat
- Collaborative learning environment
- Subject-based group organization
- File sharing capabilities
- Detailed performance analytics
- Learning progress visualization
- Strength and weakness analysis
- Personalized study recommendations
- Nuxt.js 3
- Vue.js
- Tailwind CSS
- Chart.js for analytics
- Markdown-it for content rendering
- Highlight.js for code syntax highlighting
- Nuxt Server Routes
- Google Gemini AI API
- Firebase Integration
- File handling with h3-formidable
- Firebase Authentication
- Protected routes
- User profile management
- Chat Interface (
components/tutor/ChatInterface.vue
) - Quiz Generator (
pages/subjects/[subjectID]/quiz.vue
) - Task Board (
components/TaskBoard.vue
) - Calendar (
components/calendar.vue
) - Formatted Message (
components/tutor/FormattedMessage.vue
)
The project uses several API endpoints:
/api/chat
- AI tutor interactions/api/generate-quiz
- Quiz generation/api/generate-analysis
- Performance analysis/api/quotes
- Motivational quotes
- Custom Tailwind configuration
- Responsive design
- Modern UI components
- Gradient effects and animations
- Node.js (Latest LTS version)
- NPM or other package manager
- Google Gemini API key
- Firebase project credentials
- Clone the repository
- Install dependencies:
npm install
- Create a
.env
file with required credentials:
GEMINI_API_KEY=your_gemini_api_key
FIREBASE_API_KEY=your_firebase_api_key
FIREBASE_AUTH_DOMAIN=your_auth_domain
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_STORAGE_BUCKET=your_storage_bucket
FIREBASE_MESSAGING_SENDER_ID=your_sender_id
FIREBASE_APP_ID=your_app_id
- Start the development server:
npm run dev
The AI tutor provides intelligent responses using Google's Gemini AI model. It can:
- Answer subject-specific questions
- Explain complex concepts
- Analyze uploaded materials
- Provide code examples with syntax highlighting
The quiz generator creates personalized quizzes with:
- Multiple difficulty levels
- Custom question counts
- File upload support for context
- Detailed explanations
- Performance tracking
The system tracks and analyzes:
- Quiz performance
- Study patterns
- Strengths and weaknesses
- Learning progress over time
Contributions are welcome!