Smart Study is a full-stack web application that helps students learn more effectively using AI. It transforms raw notes and study materials into interactive summaries, quizzes, and personalised study plans — all in one place.

Students upload their notes (PDFs, images, or plain text) and the app uses AI to generate:

• Instant summaries — short, detailed, or key-point formats, written the way a tutor would explain them
• Adaptive quizzes — auto-generated multiple-choice questions with scoring and a 30-second timer per question
• 24/7 AI chat tutor — ask any question and get clear answers with examples and follow-up suggestions
• Voice note recording — speak during a lecture and have your words transcribed and saved as a note automatically
• Study planner — drag-and-drop weekly schedule with a built-in Pomodoro timer
• Progress analytics — XP points, streaks, heatmaps, and badges that make studying feel like a game

src/
├── routes/              # File-based pages (TanStack Router)
│   ├── index.tsx        # Public landing page
│   ├── login.tsx
│   ├── register.tsx
│   ├── forgot-password.tsx
│   └── app/             # Protected routes (requires login)
│       ├── route.tsx    # Auth guard + app shell
│       ├── index.tsx    # Dashboard
│       ├── notes.tsx    # Upload & manage notes
│       ├── summary.tsx  # AI-generated summaries
│       ├── quiz.tsx     # Quiz with timer and scoring
│       ├── chat.tsx     # AI tutor chat
│       ├── planner.tsx  # Study planner + Pomodoro
│       ├── analytics.tsx
│       ├── settings.tsx
│       └── record.tsx   # Voice note recording
├── services/            # API call functions
├── components/          # Shared UI components
├── context/             # Auth context
├── lib/                 # Axios instance, utilities, mock data
├── hooks/
└── types/               # Global TypeScript declarations

• Node.js 18+
• A running backend API server (see backend repo) on port 5000

# Clone the repository
git clone <repo-url>
cd Student-buddy

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env

Edit .env and set the backend URL:

VITE_API_URL=http://localhost:5000

# Development server
npm run dev

# Production build
npm run build

# Preview production build
npm run preview

The frontend expects a REST API with these endpoints:

Upload PDFs, images, or text files. Notes are listed with metadata and can be sent directly to the AI for summarisation or quiz generation.

Choose between a short summary, a detailed breakdown, or a key-points list. Summaries are cached so repeated requests are instant.

Select a note or type a topic, and the AI generates 5 multiple-choice questions. Each question has a 30-second countdown. Final score is saved and tracked over time.

A persistent chat interface. Pre-built prompt suggestions help students get started quickly. Supports follow-up questions and concept explanations.

Uses the Web Speech API (Chrome/Edge) to transcribe speech in real time during class. The transcript is saved as a note and can immediately be summarised or turned into a quiz.

A weekly grid (Mon–Sun, 8 AM–7 PM) for scheduling study sessions. Drag to reorder tasks. Built-in Pomodoro timer (25-minute focus + 5-minute break) with visual controls.

Tracks daily study streaks, total XP earned, quiz scores over time, a GitHub-style activity heatmap, and achievement badges.

• All routes under /app require authentication. Unauthenticated users are redirected to /login.
• Auth tokens are stored in localStorage and attached to every API request via an Axios interceptor.
• The app supports light and dark mode, persisted to localStorage.
• Voice recording requires a secure context (HTTPS or localhost) and a Chromium-based browser.
• Run npm run lint to check for ESLint issues and npx tsc --noEmit for type errors.