How faaiz251/quizora works
Project Type and Purpose
• Quizora is a full-stack web application: a React-based single-page frontend (built with Vite) serving as the UI layer, and an Express.js/Node.js backend exposing REST APIs.
• Purpose: Provide AI-generated quizzes of varying difficulty, track user progress and virtual coins, and secure user authentication.
File Structure Analysis
• Top-level:
• backend/ – Express server with config, controllers, middleware, models, and route definitions.
• frontend/ – React app scaffolded by Vite, with Tailwind CSS, React Router, and Axios.
• Backend patterns:
• MVC-style separation: controllers (authController, etc.), models (User.js), routes (answerRoutes, questionRoutes, userRoutes), plus auth middleware.
• Configuration (gemini.js) for AI integration, dotenv for environment.
• Frontend patterns:
• Public vs src folders—static assets vs React code.
• Components (Navbar, pages folder), routing (React Router), private route guard.
• Styling with Tailwind (tailwind.config.js), build via Vite (vite.config.js).
README Insights
• Tech stack confirms MongoDB for persistence, Gemini API for dynamic question generation, CORS & dotenv for security & config.
• Features highlight authentication, quiz workflow, difficulty levels, coin accounting.
a. Main Components
1. Client (Browser) – React SPA
2. Frontend App – UI + Router + Axios
3. API Layer – Express.js server exposing /auth, /questions, /answers, /users
4. Business Logic
• Authentication service (JWT, password hashing)
• Quiz service (calls Gemini API)
• Coin management service
5. Data Layer – MongoDB (Users collection, QuizHistory, Coins)
6. External Service – Gemini AI API
7. Infrastructure – Hosting (e.g., AWS/GCP), Env & CORS config
b. Relationships & Data Flow
• User → React UI (login/register, quiz pages)
• React UI → Axios calls REST endpoints
• Express routes → corresponding controllers → business logic
• Quiz controller → Gemini API → returns questions → response to UI
• Answer controller → evaluates, updates coin balance in MongoDB
• User controller → CRUD operations on user profile
c. Architectural Patterns
• MVC pattern in backend
• SPA with client-side routing in frontend
• Layered architecture: Presentation → API → Service → Data
• External-service integration for AI
d. Key Technologies
• Frontend: React.js, Vite, Tailwind CSS, React Router, Axios
• Backend: Node.js, Express.js, Mongoose (MongoDB ODM), dotenv, CORS
• External: Gemini AI API
Essential Details to Capture
• User authentication lifecycle and middleware protection.
• API endpoints by functional area (auth, questions, answers, users).
• Flow of coin transactions tied to quiz outcomes.
• Dynamic vs static question data (AI-generated vs stored).
• Deployment concerns (environment variables, CORS policy).