How abdelhak-elgo/quizgen works
QuizGen turns teacher-uploaded course PDFs into editable quizzes, then supports publishing sessions for students, grading attempts, analytics, and LMS exports. The principal path is document ingestion → asynchronous NLP generation → teacher review/publication → student session and results. The README documents these product flows; source excerpts substantiate selected backend session, quiz-export, and NLP internals. Other unsampled subsystem connections are omitted rather than inferred.
Main entry points: tasks.py Generation tasks · QuizController.java Quiz API · SessionServiceImpl.java Session workflow · App.tsx Role-based app
Components 25
Role-based web app
- Role-based app
artifacts/frontend/src/App.tsx - Authentication UI
artifacts/frontend/src/components/auth-provider.tsx - Quiz authoring
artifacts/frontend/src/pages/enseignant/quiz-editor.tsx - Student exams
artifacts/frontend/src/pages/etudiant/exam.tsx
Quiz platform API
- Quiz API
backend/src/main/java/ma/quizgen/controller/QuizController.java - Quiz workflow
backend/src/main/java/ma/quizgen/service/QuizService.java - Document management
backend/src/main/java/ma/quizgen/service/DocumentService.java - LMS exports
backend/src/main/java/ma/quizgen/controller/QuizController.java - Quiz state
backend/src/main/java/ma/quizgen/entity/Quiz.java
Async NLP generation
- NLP service API
nlp-service/app/main.py - Generation tasks
nlp-service/app/tasks.py - PDF and NLP analysis
nlp-service/app/nlp_pipeline.py - Semantic retrieval
nlp-service/app/rag_store.py - LLM generation
nlp-service/app/llm_client.py
Sessions and assessment
- Session API
backend/src/main/java/ma/quizgen/controller/SessionController.java - Session workflow
backend/src/main/java/ma/quizgen/service/impl/SessionServiceImpl.java - Session state
backend/src/main/java/ma/quizgen/entity/Session.java - Attempt state
backend/src/main/java/ma/quizgen/entity/Attempt.java
Identity and services
- Keycloak identity
- MinIO document storage
- Redis task broker
- Configured LLM provider
- PostgreSQL
Other components
- Teacher
- Student
Connections 25
- Teacher → Role-based app: uses
- Student → Role-based app: uses
- Role-based app → Authentication UI: authenticates
- Teacher → Document management: uploads PDF
- Teacher → Quiz authoring: authors quiz
- Student → Student exams: takes exam
- Quiz authoring → Quiz API: creates and edits
- Student exams → Session API: joins session
- Quiz API → Quiz workflow: delegates to
backend/src/main/java/ma/quizgen/controller/QuizController.java - Quiz API → LMS exports: dispatches export
backend/src/main/java/ma/quizgen/controller/QuizController.java - Quiz workflow → Quiz state: manages
- Quiz API → NLP service API: requests generation
- Document management → MinIO document storage: stores files
- NLP service API → Generation tasks: dispatches tasks
nlp-service/app/main.py - Generation tasks → MinIO document storage: downloads PDF
nlp-service/app/tasks.py - Generation tasks → PDF and NLP analysis: extracts and analyzes
nlp-service/app/tasks.py - Generation tasks → Semantic retrieval: indexes chunks
nlp-service/app/tasks.py - Generation tasks → LLM generation: generates questions
nlp-service/app/tasks.py - Generation tasks → Redis task broker: queues work
- LLM generation → Configured LLM provider: calls provider
- Session API → Session workflow: delegates to
backend/src/main/java/ma/quizgen/controller/SessionController.java - Session workflow → Session state: creates sessions
backend/src/main/java/ma/quizgen/service/impl/SessionServiceImpl.java - Session workflow → Attempt state: creates attempts
backend/src/main/java/ma/quizgen/service/impl/SessionServiceImpl.java - Authentication UI → Keycloak identity: authenticates
- Quiz API → PostgreSQL: persists data