Skip to content

BrainBuddy - AI Powered Learning Platform for Kids ( 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. )

Notifications You must be signed in to change notification settings

ankushkhakale/BrainBuddy-Website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

48 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

BrainBuddy - AI-Powered Learning Platform for Kids

Deployed on Vercel Built with Next.js TypeScript Tailwind CSS

๐Ÿง  Overview

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.

โœจ Key Features

  • ๐Ÿค– 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

๐Ÿš€ Live Demo

View Live Demo

๐Ÿ› ๏ธ Tech Stack

  • 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

๐Ÿ“‹ Prerequisites

Before you begin, ensure you have the following installed:

๐Ÿš€ Quick Start

1. Clone the Repository

git clone https://github.com/yourusername/brainbuddy.git
cd brainbuddy

2. Install Dependencies

npm install
# or
pnpm install

3. Environment Setup

Create 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

4. Database Setup

  1. Create a Supabase project
  2. Run the database setup scripts in order:
    • scripts/setup-database-clean.sql
    • scripts/setup-policies.sql
    • scripts/setup-functions.sql
    • scripts/setup-storage.sql

5. Start Development Server

npm run dev
# or
pnpm dev

Open http://localhost:3000 to view the application.

๐Ÿ“š Detailed Setup Guide

For comprehensive setup instructions, see SETUP_GUIDE.md

๐Ÿ—๏ธ Project Structure

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

๐ŸŽฏ Core Features

AI-Powered Learning

  • 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

Gamification System

  • 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

Progress Analytics

  • Learning Dashboard: Visual progress overview
  • Performance Metrics: Detailed analytics and insights
  • Study Time Tracking: Monitor learning sessions
  • Quiz History: Review past performance

๐Ÿ”ง API Endpoints

  • POST /api/chat - AI chat functionality
  • POST /api/extract-text - Document text extraction
  • POST /api/generate-quiz - AI quiz generation
  • POST /api/generate-summary - Content summarization
  • POST /api/generate-quote - Quote generation

๐ŸŽจ Customization

Themes

The application supports both light and dark themes with automatic system preference detection.

Styling

Built with Tailwind CSS for easy customization. Component styles can be modified in the respective component files.

๐Ÿš€ Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Connect your repository to Vercel
  3. Add environment variables in Vercel dashboard
  4. Deploy automatically

Other Platforms

The application can be deployed to any platform that supports Next.js:

  • Netlify
  • Railway
  • DigitalOcean App Platform
  • AWS Amplify

๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“ License

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

๐Ÿ†˜ Support

If you encounter any issues:

  1. Check the SETUP_GUIDE.md for common solutions
  2. Review the browser console for error messages
  3. Verify all environment variables are correctly set
  4. Ensure database setup scripts have been executed successfully

๐Ÿ™ Acknowledgments


  1. Create and modify your project using v0.dev
  2. Deploy your chats from the v0 interface
  3. Changes are automatically pushed to this repository
  4. Vercel deploys the latest version from this repository

hello making Made with โค๏ธ for the future of education

About

BrainBuddy - AI Powered Learning Platform for Kids ( 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. )

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5