Skip to content

Turn messy notes into clear explanations, quizzes, and flashcards with AI, so you can study less and remember more.

License

Notifications You must be signed in to change notification settings

VxidDev/eduDuck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

191 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿฆ† EduDuck ๐Ÿฆ†


AI-powered study companion that transforms your notes into interactive quizzes, flashcards, and enhanced study materials.


๐Ÿ“š Table of Contents


โœจ Features

Feature Description
๐Ÿ“ Quiz Generator Upload notes โ†’ instant quizzes
๐Ÿ—‚๏ธ Flashcard Generator Spaced repetition flashcards from any subject
โœจ Note Enhancer AI-powered summaries, diagrams, key concepts
๐Ÿ“† Study Plan Generator AI-generated daily study plans tailored to your notes, goals, time, and learning style
๐Ÿฆ† DuckAI Chat with your notes, get explanations & study tips
๐Ÿ“ฑ Multi-format TXT, PDF, PNG/JPG, handwritten notes via OCR
๐ŸŒ Multi-language English, Polish, German, French, Ukrainian, Russian
๐ŸŽจ Modern UI Dark/light mode, mobile-first, glassmorphism design
๐Ÿ”‘ Google OAuth Login Sign in instantly with Google, no password required

๐Ÿ‘ค Accounts

EduDuck supports user accounts to provide fair access limits and enable future personalization features.

๐Ÿ†“ Free Account Benefits

Creating a free account unlocks:

  • ๐ŸŽฏ 3 free uses per day across:
    • Quiz Generator
    • Flashcard Generator
    • Note Enhancer
    • Study Plan Generator
    • ๐Ÿฆ† DuckAI chat
  • ๐ŸŒ Access across all supported languages
  • ๐Ÿ—‚๏ธ Viewing past queries and chats.
  • ๐Ÿ”’ Usage tracking to prevent abuse and keep the service available

Free usage resets daily. No payment required.


๐Ÿ”ฎ Planned Account Features

Accounts are the foundation for upcoming features, including:

  • ๐Ÿ“š Quiz & study history
  • ๐Ÿ“Š Learning progress tracking
  • โ˜๏ธ Cloud-saved notes and generated materials
  • โญ Premium tiers with higher or unlimited usage

๐Ÿ“Œ Why Accounts?

EduDuck relies on paid AI APIs.
Accounts help:

  • keep a free tier available for students
  • prevent abuse
  • sustainably scale the platform ๐Ÿš€

Star History

Star History Chart

๐Ÿš€ Quick Start

1. Get a Free API Key

(Hugging Face, Google Gemini, or OpenAI)

Provider Link Free Tier
๐Ÿค— Hugging Face https://huggingface.co/settings/tokens 1M tokens/month
โญ Google Gemini https://aistudio.google.com/app/apikey 15 RPM
๐Ÿ”ฅ OpenAI https://platform.openai.com/api-keys ~$0.001/quiz

2. Try the Live Demo

๐Ÿ‘‰ https://eduduck.app

3. Paste your notes โ†’ Generate โ†’ Learn!


๐ŸŽ“ Who Is EduDuck For?

  • Students who want to learn faster from their own notes
  • Teachers creating quizzes and study materials
  • Self-learners preparing for exams
  • Anyone tired of re-reading notes instead of testing knowledge

๐Ÿ› ๏ธ Tech Stack

Frontend

  • Languages: HTML5, CSS3 (CSS variables), JavaScript, TypeScript
  • Libraries: markdown-it

Backend (Flask / Python)

  • Framework: Flask
  • Auth: Flask-Login, Authlib (Google/GitHub/Discord/Microsoft OAuth), Werkzeug (security + password hashing), secrets, JWT
  • Data: MongoDB (PyMongo), BSON, certifi
  • AI + HTTP: httpx (HTTP/2, connection pooling), OpenAI/Gemini/Hugging Face integrations, requests (Mailgun)
  • Storage: Cloudflare R2 via boto3/botocore
  • File processing: pypdf, Pillow (PIL), python-magic (file type detection), defusedxml (SVG/XML safety), io.BytesIO, base64
  • Utilities: python-dotenv, uuid, re, functools, msgspec (fast JSON), json, os, atexit, datetime, collections, math, random
  • Security & rate limiting: Flask-WTF (CSRF), Flask-Limiter, Werkzeug, defusedxml, python-magic
  • Logging: rich
  • i18n: Flask-Babel

AI APIs

  • Hugging Face Inference API
  • Google Gemini (2.5 Flash)
  • OpenAI (GPT models)

Email

  • Mailgun

Rust extensions (PyO3)

  • quiz_parser
  • study_plan_parser
  • submit_quiz

๐Ÿ› ๏ธ Local Development

  1. Installation
git clone https://github.com/VxidDev/eduDuck.git
cd eduDuck
python -m venv venv
source venv/bin/activate
bash build.sh
  1. Add .env with the following variables:
FREE_TIER_API_KEY= ... (OpenAI key)
MONGODB_URI= ... (MongoDB API link)
SECRET_KEY= ... (32 char long)
GOOGLE_CLIENT_ID= ...
GOOGLE_CLIENT_SECRET= ...
MAILGUN_API_KEY= ...
VERIFICATION_EMAIL= ...
R2_ACCESS_KEY_ID= ...
R2_SECRET_ACCESS_KEY= ...
R2_ACCOUNT_ID= ...
R2_BUCKET_NAME= ...
  1. Run locally using Gunicorn
# Production-style run with 4 workers on port 5000
gunicorn -w 4 -b 0.0.0.0:5000 main:app

๐ŸŽฏ Roadmap

Status Feature
โœ… Done Basic quiz generation
โœ… Done PDF/TXT/image upload + OCR
โœ… Done Quiz & Flashcard visualization
โœ… Done Note Enhancer
โœ… Done DuckAI chat
โœ… Done Multi-language support
โœ… Done Dark mode + mobile UI
โœ… Done Quiz difficulty levels
โœ… Done Export generated material (.json)
โœ… Done OpenAI API support
โœ… Done Free daily usage (3/day)
โœ… Done UI/UX improvements
โœ… Done Study Plan Generator
โœ… Done Google OAuth
โœ… Done Email Verification
โœ… Done User accounts & quiz history
โœ… Done Improve OCR
โœ… Done Add User PFP support
โœ… Done Migrate quiz parser to C , C++ or Rust.
โœ… Done Improve AiReq
โœ… Done Add attaching files to DuckAI.
โœ… Done Fix file uploading if edited notes.textContent
โœ… Done Added password reset option
โœ… Done Added account deletion option
โœ… Done Improved UX/UI
โœ… Done Migrated part of JS code to TS
โœ… Done Fix footer not at the bottom bug.
โœ… Done Migrated most of JS code to TS.
โœ… Done Study progress tracking
โœ… Done Add note analyzer
โœ… Done Simplify UI
โœ… Done Add multi-language pages.
๐Ÿ”„ In Progress Bug fixes and polishing.
โณ Planned ???

๐Ÿค Contributions

Sponsors

Deathtyr โ€“ $30

โ€œInvest in this guy, makes life easier (I really said that!)โ€


๐Ÿ’ฐ Support the Project

Ko-fi

Your support helps upgrade hosting and add premium features! ๐Ÿฆ†


โ— Known Issues

None :D

๐Ÿ“„ License

Apache License 2.0 - see LICENSE for details.

Made with โค๏ธ by VoidDev - self-taught since June 2025

Version

About

Turn messy notes into clear explanations, quizzes, and flashcards with AI, so you can study less and remember more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors