Skip to content

RushikeshIche/EduFlow-AI

Repository files navigation

EduFlow AI+

AI-powered learning assistant for students and educators — generate clean notes and MCQs from PDFs or plain text.

Built with Next.js App Router, Tailwind CSS, and OpenRouter AI (DeepSeek model).


Features

  • Upload PDFs or paste plain text
  • AI-generated clean and concise notes
  • Multiple Choice Questions (MCQs) with answer selection
  • Answer correctness feedback
  • Export notes and questions to PDF
  • User authentication (via NextAuth or Clerk – coming soon)

Powered By


Getting Started

1. Clone the repo

git clone https://github.com/yourusername/eduflow-ai.git
cd eduflow-ai

2. Install dependencies

npm install

3. Set up environment variables

Create a .env.local file in the root directory:

OPENROUTER_API_KEY=your_openrouter_api_key_here

Get your API key from OpenRouter.ai.

4. Run the development server

npm run dev

Visit http://localhost:3000 to start using EduFlow AI+.


🗂️ Project Structure

/app
  /api
    /generateNotes
    /generateMCQ
    /parsePdf
  /components
    UploadPDF.js
    TextInput.js
    NoteDisplay.js
    MCQDisplay.js
    ExportPDF.js
  /dashboard (optional future route)
  page.js
/utils
  pdfParser.js

📦 Upcoming Features

  • Authentication with NextAuth or Clerk
  • Save history to user dashboard
  • Quiz scoring and analytics
  • Multi-language support

🧑‍💻 Contributing

Pull requests are welcome! For major changes, please open an issue first.


📄 License

MIT


🙌 Acknowledgements

Thanks to:

  • OpenAI & OpenRouter for powerful LLM APIs
  • Vercel & Next.js for the web platform
  • Tailwind Labs for amazing UI tools

🌐 Live Demo (Coming Soon)

Stay tuned!

About

AI-powered learning assistant for students and educators — generate clean notes and MCQs from PDFs or plain text. Built with Next.js App Router, Tailwind CSS, and OpenRouter AI (DeepSeek model).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors