Skip to content

🧠 Notegenius - all-in-one intelligent notes platform for students. Upload study materials, summarize them, ask questions, extract insights from YouTube videos or GitHub repositories, and supercharge your learning with AI.

Notifications You must be signed in to change notification settings

Edasgh/notegenius

Repository files navigation

🧠 Notegenius – Your AI-Powered Study Companion

Notegenius is an all-in-one intelligent notes platform for students. Upload study materials, summarize them, ask questions, extract insights from YouTube videos or GitHub repositories, and supercharge your learning with AI.

LIVE DEMO


❓ Problem Statement

In today’s fast-paced academic environment, students often struggle with managing and understanding large volumes of study material from various sourcesβ€”class notes, online lectures, YouTube videos, and open-source code repositories. Traditional note-taking methods are time-consuming, fragmented, and lack interactivity or personalization.

Students need a centralized, intelligent platform that not only stores their learning resources but also helps them understand, summarize, and interact with the content more effectively.

Notegenius addresses this challenge by providing an AI-powered environment where students can:

  • Upload study materials and generate smart summaries
  • Ask specific questions about any part of their content
  • Convert YouTube videos into structured notes
  • Explore and understand GitHub codebases through natural language
  • Generate quiz from notes

✨ Features

πŸ“„ Notes Upload & Summarization

  • Upload files (PDF, DOCX, TXT)
  • Generate concise, bullet-point, or detailed summaries
  • Highlight important sections with AI assistance
  • Export to PDF
  • Quiz generator (from notes) (MCQs or short answers)

πŸ€– AI Q&A

  • Ask questions about your uploaded notes
  • Select specific lines or text to get targeted answers
  • Get detailed answers from Gemini AI

πŸŽ₯ YouTube Video Notes

  • Paste a YouTube video link
  • Extract transcripts and generate structured notes
  • Ask follow up questions and many more.

πŸ’» GitHub Repository Q&A

  • Add any public or private (access token required) GitHub repository
  • Ask questions about code or specific files
  • Get summaries of complex functions

πŸ” Study Tools (Upcoming features)

  • Flashcard generator from notes
  • Study planner and progress tracker
  • Export to DOCX, or Anki

πŸš€ Tech Stack

Layer Technology
Frontend Next.js, Shadcn UI, Tailwind CSS
Backend Next API
AI Services Gemini API, LangChain
File Storage Convex Cloud Storage
Vector DB Convex
Auth Clerk

πŸ›  Installation

1. Clone the repo

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

2. Install dependencies

npm install
# or
yarn install

3. Set up environment variables

Create a .env.local file:

CONVEX_DEPLOYMENT=convex-deployment 
NEXT_PUBLIC_CONVEX_URL=convex-url

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=clerk-publishable-key
CLERK_SECRET_KEY=clerk-secret-key
ISSUER_URL=clerk-issuer-url

#github
GITHUB_TOKEN=your-github-token

#gemini
GEMINI_API_KEY=your-gemini-api-key

# Youtube api key
YOUTUBE_API_KEY=your-youtube-api-key

NEXT_PUBLIC_BASE_URL="http://localhost:3000"

4. Run the app

npm run dev

Visit http://localhost:3000


πŸ“¦ Folder Structure

/components      – Reusable React components
/pages           – Next.js routes
/lib             – Utility functions and API wrappers
/app/api         – Server actions and file processing
/public          – Static assets

🀝 Contributing

Contributions are welcome! Please open an issue or submit a PR if you have ideas, suggestions, or fixes.


πŸ“„ License

MIT License


πŸ™Œ Acknowledgements


πŸ“¬ Contact

Made with ❀️ for students everywhere.

About

🧠 Notegenius - all-in-one intelligent notes platform for students. Upload study materials, summarize them, ask questions, extract insights from YouTube videos or GitHub repositories, and supercharge your learning with AI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published