Skip to content

nishal21/StudyForge

Repository files navigation

🚀 StudyForge

AI-powered study companion: notes, flashcards, quizzes, planning, and more!

✨ Overview

StudyForge is your all-in-one AI-powered study platform. Organize notes, generate flashcards and quizzes, plan your study schedule, track sessions, and chat with Gemini AI for instant help—all in a beautiful, modern interface.


🧩 Features

  • 📋 Dashboard: Quick stats, daily study tips, and fast actions
  • 📝 My Notes: Create, tag, and manage notes (text, voice, camera)
  • 🃏 Flashcards & Quizzes: AI-generated flashcards and quizzes from your notes
  • 📅 Study Planner: Smart, AI-assisted study plans and progress tracking
  • ⏱️ Study Sessions: Pomodoro/deep work timers, ambient sounds, motivational messages
  • 🤖 Ask AI: Chat with Google Gemini for explanations, summaries, and more
  • 🌙 Modern UI: Responsive, dark-themed, and mobile-friendly

🚀 Quick Start

Prerequisites: Node.js (v18+ recommended)

  1. Install dependencies:
    npm install
  2. Set your Gemini API key:
    • Create a file named .env.local in the root directory
    • Add your key:
      GEMINI_API_KEY=your-google-gemini-api-key
  3. Run the app locally:
    npm run dev
  4. Open http://localhost:5173 in your browser

🖼️ Screenshots

🌐 Web Screenshots

LandingPage Dashbaord Notes FlashCard & Quizes FocusTimer

📱 Mobile Screenshots

Mobile Dashboard Side Bar Focus Time Study Planner Ask AI

⚙️ Tech Stack

  • React 19 + Vite + TypeScript
  • Google Gemini AI for chat, flashcards, quizzes, and study tips
  • LocalStorage for persistent user data

📚 Main Components

  • Dashboard: Stats, daily tips, quick actions
  • My Notes: Rich note-taking (text, voice, camera)
  • Flashcards & Quizzes: AI-generated, interactive study tools
  • Study Planner: Personalized, trackable plans
  • Study Sessions: Timers, ambient music, motivation
  • Ask AI: Gemini-powered Q&A and explanations

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you’d like to change.


📄 License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published