Skip to content

Repository files navigation

Optimum

Optimum — Generated Quizzes by Uploading PDF using AI

A web application that lets users upload PDFs and automatically generates interactive quizzes from the contents using AI.


🚀 Features

  • Upload any PDF and generate quiz questions instantly.
  • AI-powered question generation.
  • Clean and responsive UI.
  • Immediate quiz preview.

🧰 Tech Stack

  • Frontend: TypeScript, Vite (adjust based on actual setup)
  • Backend: Node.js
  • Shared: Common utilities under shared/
  • Other: Config files like drizzle.config.ts, firebase-rules.txt

📁 Project Structure

/client
/server
/shared
/script
/attached_assets/generated_images
.gitignore
package.json
LICENSE
README.md

🏁 Getting Started

Prerequisites

  • Node.js + npm
  • Required environment variables (API keys, storage configs, etc.)

Installation

git clone https://github.com/nareshAiNexus/Optimum.git
cd Optimum
npm install

Run (Development)

cd server && npm run dev
cd client && npm run dev

Build

cd client && npm run build
cd server && npm start

📄 Usage

  1. Open the app in your browser.
  2. Upload a PDF.
  3. AI processes and generates questions.
  4. Take the quiz.

🔮 Future Improvements

  • Support for large PDFs.
  • Multiple quiz formats.
  • Authentication.
  • Database storage.
  • Better UI/UX.
  • Export quizzes as PDF/CSV.

🤝 Contributing

  1. Fork the repo.
  2. Create a branch.
  3. Commit and push changes.
  4. Open a pull request.

📄 License

Licensed under GPL-3.0.


🙏 Acknowledgements

Inspired by AI-powered quiz-generation tools and open-source contributors.

About

Generated Quizzes by uploading pdf using AI.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages