BrainBuddy is an innovative AI-powered learning platform designed specifically for students under 15. It transforms traditional study sessions into exciting, gamified learning adventures using cutting-edge AI technology.
- ๐ค AI-Powered Content Generation: Automatically creates quizzes, summaries, and study materials from uploaded documents
- ๐ฎ Gamified Learning: XP system, levels, achievements, and leaderboards to keep students engaged
- ๐ฌ Interactive AI Chat: Real-time conversation with an AI tutor for personalized learning support
- ๐ Progress Tracking: Comprehensive analytics and progress visualization
- ๐ Achievement System: Unlock badges and rewards for learning milestones
- ๐ฑ Responsive Design: Works seamlessly on desktop, tablet, and mobile devices
- ๐ Dark/Light Mode: Beautiful theme switching for comfortable learning
- Frontend: Next.js 15, React 18, TypeScript
- Styling: Tailwind CSS, Radix UI Components
- Backend: Supabase (Database, Authentication, Storage)
- AI Integration: Google Gemini AI
- Deployment: Vercel
- State Management: React Context API
- Animations: Framer Motion
Before you begin, ensure you have the following installed:
git clone https://github.com/yourusername/brainbuddy.git
cd brainbuddynpm install
# or
pnpm installCreate a .env.local file in the project root:
NEXT_PUBLIC_SUPABASE_URL=your_supabase_project_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
GEMINI_API_KEY=your_gemini_api_key- Create a Supabase project
- Run the database setup scripts in order:
scripts/setup-database-clean.sqlscripts/setup-policies.sqlscripts/setup-functions.sqlscripts/setup-storage.sql
npm run dev
# or
pnpm devOpen http://localhost:3000 to view the application.
For comprehensive setup instructions, see SETUP_GUIDE.md
brainbuddy/
โโโ app/ # Next.js app directory
โ โโโ api/ # API routes
โ โโโ dashboard/ # Main dashboard page
โ โโโ login/ # Authentication pages
โ โโโ signup/ # Registration page
โโโ components/ # React components
โ โโโ ui/ # Reusable UI components
โ โโโ ... # Feature-specific components
โโโ contexts/ # React contexts
โโโ hooks/ # Custom React hooks
โโโ lib/ # Utility libraries
โโโ scripts/ # Database setup scripts
โโโ public/ # Static assets
- Document Processing: Upload PDFs, images, or text files
- Quiz Generation: AI creates interactive quizzes from content
- Summary Creation: Automatic content summarization
- Smart Chat: Context-aware AI tutoring
- XP Points: Earn experience for completing activities
- Level Progression: Level up based on XP earned
- Achievement Badges: Unlock rewards for milestones
- Streak Tracking: Maintain daily learning streaks
- Leaderboards: Compete with other students
- Learning Dashboard: Visual progress overview
- Performance Metrics: Detailed analytics and insights
- Study Time Tracking: Monitor learning sessions
- Quiz History: Review past performance
POST /api/chat- AI chat functionalityPOST /api/extract-text- Document text extractionPOST /api/generate-quiz- AI quiz generationPOST /api/generate-summary- Content summarizationPOST /api/generate-quote- Quote generation
The application supports both light and dark themes with automatic system preference detection.
Built with Tailwind CSS for easy customization. Component styles can be modified in the respective component files.
- Push your code to GitHub
- Connect your repository to Vercel
- Add environment variables in Vercel dashboard
- Deploy automatically
The application can be deployed to any platform that supports Next.js:
- Netlify
- Railway
- DigitalOcean App Platform
- AWS Amplify
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
If you encounter any issues:
- Check the SETUP_GUIDE.md for common solutions
- Review the browser console for error messages
- Verify all environment variables are correctly set
- Ensure database setup scripts have been executed successfully
- Next.js for the amazing React framework
- Supabase for backend services
- Google Gemini AI for AI capabilities
- Radix UI for accessible components
- Tailwind CSS for styling
- Create and modify your project using v0.dev
- Deploy your chats from the v0 interface
- Changes are automatically pushed to this repository
- Vercel deploys the latest version from this repository
hello making Made with โค๏ธ for the future of education