Skip to content

Repository files navigation

📚 StudyMate AI

Turn textbooks, lecture notes, research papers, readings, and meeting transcripts into easy-to-understand study guides using AI.

StudyMate AI is a modern AI-powered learning assistant designed to help students, professionals, and lifelong learners study smarter—not harder. Upload a document or paste text, and instantly generate summaries, flashcards, quizzes, definitions, and simplified explanations.


🚀 Live Demo

🔗 Live Application: https://study-mate-ai-sable.vercel.app


📸 Preview

Screenshots will be added after deployment.


✨ Features

  • 📄 Upload PDF, TXT, or paste text directly
  • 🤖 AI-generated summaries (Short, Medium & Detailed)
  • 🧠 Explain complex topics in simple language
  • 📌 Extract key points
  • 📖 Generate important definitions and glossary
  • 🎴 Create interactive flashcards
  • ❓ Generate practice quizzes
  • 📝 Build structured study guides
  • 📋 Copy generated content with one click
  • 🖨️ Print study materials
  • 🌙 Automatic Light/Dark Mode with manual theme toggle
  • 📱 Fully responsive across desktop, tablet, and mobile

🛠️ Tech Stack

Frontend

  • Next.js (App Router)
  • React
  • TypeScript
  • Tailwind CSS
  • shadcn/ui
  • Lucide React
  • Framer Motion

AI & Document Processing

  • Google Gemini API (or configurable AI provider)
  • PDF.js
  • Mammoth.js (DOCX support)

Deployment

  • Vercel
  • GitHub

📂 Project Structure

app/
components/
features/
hooks/
lib/
services/
types/
utils/
public/
styles/

⚙️ Getting Started

1. Clone the repository

git clone https://github.com/morddy-tech/StudyMateAI.git

2. Install dependencies

npm install

3. Configure environment variables

Create a .env.local file in the project root.

GEMINI_API_KEY=your_api_key_here

Replace the value with your own API key.


4. Start the development server

npm run dev

Visit:

http://localhost:3000

💡 How It Works

  1. Upload a PDF or paste text.

  2. Choose one or more AI actions:

    • Summary
    • Explain Simply
    • Flashcards
    • Quiz
    • Definitions
    • Key Points
    • Study Guide
  3. Let the AI process the content.

  4. Review, copy, print, or export your study materials.


🎯 Project Goals

StudyMate AI aims to make learning faster and more effective by transforming lengthy documents into concise, structured, and interactive study resources.

This project demonstrates:

  • Modern Full-Stack Development
  • AI Integration
  • File Upload & Parsing
  • Responsive UI/UX
  • TypeScript Best Practices
  • Component-Based Architecture
  • API Integration
  • Prompt Engineering

🗺️ Roadmap

Future enhancements include:

  • ✅ AI chat with uploaded documents
  • ✅ OCR for scanned PDFs
  • ✅ Audio summaries (Text-to-Speech)
  • ✅ Mind map generation
  • ✅ User authentication
  • ✅ Saved study history
  • ✅ Spaced repetition planner
  • ✅ Multi-language support
  • ✅ Collaborative study sessions

🤝 Contributing

Contributions, suggestions, and feedback are welcome.

If you'd like to contribute:

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Open a Pull Request

📄 License

This project is licensed under the MIT License.


👨‍💻 Developer

Ifedayo Matthew

📧 Email: ifedmord5194@gmail.com


🌐 Acknowledgements

This project was built as part of the Digital Heroes Developer Trial Task.

Special thanks to the Digital Heroes team for the opportunity to build a practical AI-powered application.


Built for Digital Heroes

Visit: https://digitalheroesco.com

About

AI-powered study assistant that transforms textbooks, lecture notes, readings, and meeting transcripts into summaries, study guides, flashcards, quizzes, and simplified explanations using modern AI.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages