# sarthak0006/quizapp architecture

> Architecture diagram of the GitHub repository sarthak0006/quizapp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sarthak0006/quizapp
- Repository: https://github.com/sarthak0006/quizapp

## Overview

##### Project Type and Purpose
- This is a full-stack “Skill Assessment & Reporting Portal”: a quiz platform with user registration/login, multi-role access (Admin/User), skill-based quizzes, scoring, and performance reports.
- Frontend: React + Vite + Redux + TypeScript + shadcn/ui + Recharts.
- Backend: Node.js + Express + TypeScript + MySQL + JWT auth + middleware for CSRF, CORS, rate-limiting.
- Deployment: Frontend on Vercel (CDN/static files), Backend in Docker, MySQL managed separately.

##### File Structure
- Top-level: `backend/`, `frontend/`, plus root README.
- backend/
– Docker setup: `Dockerfile`, `.dockerignore`.
– Env examples: `.env.example`.
– Scripts: `db-reset.ts`, `seed.ts`.
– Source:
- `src/setup`: app initialization, error handlers.
- `src/server.ts`: entry point.
- `src/routes`: REST endpoints (`auth`, `users`, `skills`, `questions`, `quiz`, `reports`).
- `src/middleware`: JWT auth, CSRF, rate-limit, security headers, validation.
- `src/lib/db.ts`: MySQL connection.
- `src/utils`: JWT utils, pagination.
- frontend/
– Vite config, ESLint, tsconfigs.
– Entry: `index.html`, `main.tsx`.
– UI: `components/ui` (buttons, dialogs, inputs, etc.), `pages` (Login, Register, Dashboard, AdminXYZ, Reports, Attempts).
– State: Redux slices (`authSlice`, `uiSlice`) in `store`.
– API client: `lib/axios.ts`.
– Assets, global styles, theme provider, hooks.

##### README for Additional Insights
- Features list: JWT in HttpOnly cookies, multi-role, CSRF, CORS, rate-limiting, bcrypt hashing.
- Tech stack call-outs: React, Vite, Express, MySQL, Docker, Vercel.
- Mentions SQL migrations/seeds under `sql/` (not shown in file tree but implied).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["Browser"]:::external
        Vercel["Vercel CDN\n(Static Hosting)"]:::external
        ReactApp["React App"]:::frontend
        AppTS["App Component"]:::frontend
        HTML["index.html"]:::frontend
        ViteConfig["vite.config.ts"]:::frontend
        ReduxStore["Redux Store"]:::frontend
        AuthSlice["authSlice.ts"]:::frontend
        UiSlice["uiSlice.ts"]:::frontend
        ApiClient["API Client\naxios.ts"]:::frontend
        UIComponents["UI Library\ncomponents/ui/"]:::frontend
        Pagination["Pagination Component"]:::frontend
        ThemeToggle["Theme Toggle"]:::frontend
        ThemeProvider["Theme Provider"]:::frontend
        Hooks["Hooks"]:::frontend
        Pages["Page Views\n(Login, Register,\nDashboard, Admin,\nReports, Attempts)"]:::frontend

        Browser --> Vercel
        Vercel --> ReactApp
        ReactApp --> AppTS
        ReactApp --> HTML
        ReactApp --> ViteConfig
        ReactApp --> ReduxStore
        ReduxStore --> AuthSlice
        ReduxStore --> UiSlice
        ReactApp --> ApiClient
        ReactApp --> UIComponents
        UIComponents --> Pagination
        UIComponents --> ThemeToggle
        UIComponents --> ThemeProvider
        ReactApp --> Hooks
        ReactApp --> Pages
        Pages -->|"uses"| ApiClient
        ApiClient -->|"HTTP Requests"| Express
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        subgraph "Docker Container\n(Express Server)" 
            direction TB
            Express["Express API"]:::backend
            AppInit["App Init"]:::backend
            ErrorHandler["Error Handler"]:::backend
            Middleware["Middleware Pipeline"]:::backend
            AuthMw["auth.ts"]:::backend
            CSRFMw["csrf.ts"]:::backend
            RateLimit["rateLimit.ts"]:::backend
            SecHeaders["securityHeaders.ts"]:::backend
            Validate["validate.ts"]:::backend
            AsyncHandler["asyncHandler.ts"]:::backend
            RoutesAuth["auth.ts"]:::backend
            RoutesUsers["users.ts"]:::backend
            RoutesSkills["skills.ts"]:::backend
            RoutesQuestions["questions.ts"]:::backend
            RoutesQuiz["quiz.ts"]:::backend
            RoutesReports["reports.ts"]:::backend
            UtilsJWT["JWT Utils"]:::backend
            UtilsPag["Pagination Utils"]:::backend
            DBConnector["DB Connector"]:::datastore

            Express --> AppInit
            Express --> ErrorHandler
            Express --> Middleware
            Middleware --> AuthMw
            AuthMw --> CSRFMw
            CSRFMw --> RateLimit
            RateLimit --> SecHeaders
            SecHeaders --> Validate
            Validate --> AsyncHandler
            AsyncHandler --> RoutesAuth
            AsyncHandler --> RoutesUsers
            AsyncHandler --> RoutesSkills
            AsyncHandler --> RoutesQuestions
            AsyncHandler --> RoutesQuiz
            AsyncHandler --> RoutesReports
            RoutesAuth --> DBConnector
            RoutesUsers --> DBConnector
            RoutesSkills --> DBConnector
            RoutesQuestions --> DBConnector
            RoutesQuiz --> DBConnector
            RoutesReports --> DBConnector
            Express --> UtilsJWT
            Express --> UtilsPag
            DBConnector --> MySQL
        end
        Scripts["DB Scripts"]:::backend
        DockerConfig["Docker Config"]:::backend

        Scripts --> DBConnector
        DockerConfig --> Express
    end

    MySQL["MySQL Database"]:::datastore

    %% Click Events
    click ReactApp "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/main.tsx"
    click AppTS "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/App.tsx"
    click HTML "https://github.com/sarthak0006/quizapp/blob/main/frontend/index.html"
    click ViteConfig "https://github.com/sarthak0006/quizapp/blob/main/frontend/vite.config.ts"
    click ReduxStore "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/store/index.ts"
    click AuthSlice "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/store/authSlice.ts"
    click UiSlice "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/store/uiSlice.ts"
    click ApiClient "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/lib/axios.ts"
    click UIComponents "https://github.com/sarthak0006/quizapp/tree/main/frontend/src/components/ui/"
    click Pagination "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/components/Pagination.tsx"
    click ThemeToggle "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/components/ThemeToggle.tsx"
    click ThemeProvider "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/components/theme-provider.tsx"
    click Hooks "https://github.com/sarthak0006/quizapp/blob/main/frontend/src/hooks.ts"
    click Express "https://github.com/sarthak0006/quizapp/blob/main/backend/src/server.ts"
    click AppInit "https://github.com/sarthak0006/quizapp/blob/main/backend/src/setup/app.ts"
    click ErrorHandler "https://github.com/sarthak0006/quizapp/blob/main/backend/src/setup/error.ts"
    click AuthMw "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/auth.ts"
    click CSRFMw "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/csrf.ts"
    click RateLimit "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/rateLimit.ts"
    click SecHeaders "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/securityHeaders.ts"
    click Validate "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/validate.ts"
    click AsyncHandler "https://github.com/sarthak0006/quizapp/blob/main/backend/src/middleware/asyncHandler.ts"
    click RoutesAuth "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/auth.ts"
    click RoutesUsers "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/users.ts"
    click RoutesSkills "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/skills.ts"
    click RoutesQuestions "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/questions.ts"
    click RoutesQuiz "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/quiz.ts"
    click RoutesReports "https://github.com/sarthak0006/quizapp/blob/main/backend/src/routes/reports.ts"
    click DBConnector "https://github.com/sarthak0006/quizapp/blob/main/backend/src/lib/db.ts"
    click UtilsJWT "https://github.com/sarthak0006/quizapp/blob/main/backend/src/utils/jwt.ts"
    click UtilsPag "https://github.com/sarthak0006/quizapp/blob/main/backend/src/utils/pagination.ts"
    click Scripts "https://github.com/sarthak0006/quizapp/blob/main/backend/scripts/db-reset.ts"
    click Scripts "https://github.com/sarthak0006/quizapp/blob/main/backend/scripts/seed.ts"
    click DockerConfig "https://github.com/sarthak0006/quizapp/tree/main/backend/Dockerfile"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085
    classDef backend fill:#d4edda,stroke:#155724
    classDef datastore fill:#fff3cd,stroke:#856404
    classDef external fill:#f8d7da,stroke:#721c24
```
