# momen165/devquest architecture

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

- Interactive diagram: https://gitdiagram.com/momen165/devquest
- Repository: https://github.com/momen165/devquest

## Overview

##### Project type and purpose
- DevQuest is a full-stack coding education platform:
- Frontend: React + Vite app providing interactive lessons, code editor, dashboards
- Backend: Node.js + Express REST API handling auth, courses, code execution, payments
- Supporting services: PostgreSQL, AWS S3 storage, Stripe payments, JWT auth

##### File structure
- Top-level split:
├ client/ → React app (src/components, src/pages, AuthContext, ProtectedRoute, utils, assets)
└ server/ → Express app (config, controllers, routes, middleware, models, migrations, utils)
- Patterns:
- MVC-style on backend (routes → controllers → models)
- Context API + React Router on frontend
- Code execution endpoint likely uses sandboxed service or Docker behind codeExecution.controller
- Config & build scripts:
- client/vite.config.mjs, server/server.js, migration SQL files, dotenv for env vars

##### README for additional insights
- Technologies: React 18, Context API, Axios, Monaco Editor, Express, PostgreSQL, JWT, AWS S3, Stripe
- Features: interactive editor, multi-language support, progress tracking, admin dashboards
- Security: Helmet, rate limiting, input validation, CORS

##### Elements
- Labels: e.g., “React App”, “Express API”, “PostgreSQL DB”, “Stripe”, “AWS S3”
- Client → Server (HTTP/HTTPS)
- Server → Database (SQL)
- Server → S3 (S3 API)
- Server → Stripe (REST)
- Server → Code Sandbox (RPC or HTTP)
- Blue rectangles for UI components
- Orange rectangles for backend services
- Red clouds for external services

##### Detailed capture of essential elements
- File-upload flow: client uploads via React form → multer middleware → S3 utils → AWS S3
- Code execution flow: user code → codeExecution.controller → sandbox → test runner → back
- Payment flow: purchase → payment.controller → Stripe → webhook back to server → update DB

Guidelines for the engineer:

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        ReactSPA["React SPA"]:::frontend
        subgraph "Entry & Routing"
            direction TB
            Main["main.jsx"]:::frontend
            App["App.jsx"]:::frontend
        end
        AuthCtx["AuthContext.jsx"]:::frontend
        ProtectedRoute["ProtectedRoute.jsx"]:::frontend
        subgraph "Editor Components"
            direction TB
            MonacoEditor["MonacoEditorComponent.jsx"]:::frontend
            CustomEditor["CustomEditor.jsx"]:::frontend
            EditorUtils["editorUtils.js"]:::frontend
        end
        XPFront["xpCalculator.js"]:::frontend
        subgraph "Pages"
            direction TB
            AdminPages["pages/admin"]:::frontend
            UserPages["pages/user"]:::frontend
        end
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        ExpressServer["server.js"]:::backend
        subgraph "Middleware & Config"
            direction TB
            DBConfig["database.js"]:::backend
            MulterCfg["multer.js"]:::backend
            AuthMW["auth.js"]:::backend
            SanitizeMW["sanitizeInput.js"]:::backend
            RateLimitMW["updateUserStreak.js"]:::backend
        end
        subgraph "Routing Layer"
            direction TB
            AuthRoutes["auth.routes.js"]:::backend
            CourseRoutes["course.routes.js"]:::backend
            LessonRoutes["lesson.routes.js"]:::backend
            CodeExecRoutes["codeExecution.routes.js"]:::backend
            PaymentRoutes["payment.routes.js"]:::backend
            UploadRoutes["upload.routes.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AuthCtrl["auth.controller.js"]:::backend
            CourseCtrl["course.controller.js"]:::backend
            LessonCtrl["lesson.controller.js"]:::backend
            CodeExecCtrl["codeExecution.controller.js"]:::backend
            PaymentCtrl["payment.controller.js"]:::backend
            UploadCtrl["upload.controller.js"]:::backend
            SubscrCtrl["subscription.controller.js"]:::backend
        end
        subgraph "Services & Utils"
            direction TB
            S3Utils["s3.utils.js"]:::backend
            Logger["logger.js"]:::backend
            ErrorUtils["error.utils.js"]:::backend
            ValidationUtils["validation.utils.js"]:::backend
            XPBack["xpCalculator.js"]:::backend
        end
        subgraph "Data Layer"
            direction TB
            CourseModel["course.model.js"]:::backend
            LessonModel["lesson.model.js"]:::backend
            ActivityModel["activity.js"]:::backend
            Migrations["migrations"]:::backend
        end
    end

    %% External Services
    PostgreSQL[(PostgreSQL)]:::database
    S3["AWS S3"]:::external
    Stripe["Stripe"]:::external
    Sandbox["Code Sandbox"]:::external

    %% Connections
    ReactSPA -->|"HTTP/HTTPS\nJSON"| ExpressServer
    ExpressServer --> DBConfig
    ExpressServer --> MulterCfg
    ExpressServer --> AuthMW
    ExpressServer --> SanitizeMW
    ExpressServer --> RateLimitMW

    ExpressServer --> AuthRoutes
    ExpressServer --> CourseRoutes
    ExpressServer --> LessonRoutes
    ExpressServer --> CodeExecRoutes
    ExpressServer --> PaymentRoutes
    ExpressServer --> UploadRoutes

    AuthRoutes --> AuthCtrl
    CourseRoutes --> CourseCtrl
    LessonRoutes --> LessonCtrl
    CodeExecRoutes --> CodeExecCtrl
    PaymentRoutes --> PaymentCtrl
    UploadRoutes --> UploadCtrl

    AuthCtrl --> XPBack
    CourseCtrl --> CourseModel
    LessonCtrl --> LessonModel
    CodeExecCtrl --> Sandbox
    PaymentCtrl --> Stripe
    UploadCtrl --> S3Utils

    CourseModel --> PostgreSQL
    LessonModel --> PostgreSQL
    ActivityModel --> PostgreSQL
    Migrations --> PostgreSQL

    S3Utils --> S3
    Logger --> ExpressServer
    ErrorUtils --> ExpressServer
    ValidationUtils --> ExpressServer

    %% Click Events
    click ReactSPA "https://github.com/momen165/devquest/tree/main/client/src"
    click Main "https://github.com/momen165/devquest/blob/main/client/src/main.jsx"
    click App "https://github.com/momen165/devquest/blob/main/client/src/App.jsx"
    click AuthCtx "https://github.com/momen165/devquest/blob/main/client/src/AuthContext.jsx"
    click ProtectedRoute "https://github.com/momen165/devquest/blob/main/client/src/ProtectedRoute.jsx"
    click MonacoEditor "https://github.com/momen165/devquest/blob/main/client/src/components/MonacoEditorComponent.jsx"
    click CustomEditor "https://github.com/momen165/devquest/blob/main/client/src/components/CustomEditor.jsx"
    click EditorUtils "https://github.com/momen165/devquest/blob/main/client/src/utils/editorUtils.js"
    click XPFront "https://github.com/momen165/devquest/blob/main/client/src/utils/xpCalculator.js"
    click AdminPages "https://github.com/momen165/devquest/tree/main/client/src/pages/admin"
    click UserPages "https://github.com/momen165/devquest/tree/main/client/src/pages/user"

    click ExpressServer "https://github.com/momen165/devquest/blob/main/server/server.js"
    click DBConfig "https://github.com/momen165/devquest/blob/main/server/config/database.js"
    click MulterCfg "https://github.com/momen165/devquest/blob/main/server/config/multer.js"
    click AuthMW "https://github.com/momen165/devquest/blob/main/server/middleware/auth.js"
    click SanitizeMW "https://github.com/momen165/devquest/blob/main/server/middleware/sanitizeInput.js"
    click RateLimitMW "https://github.com/momen165/devquest/blob/main/server/middleware/updateUserStreak.js"
    click AuthRoutes "https://github.com/momen165/devquest/blob/main/server/routes/auth.routes.js"
    click CourseRoutes "https://github.com/momen165/devquest/blob/main/server/routes/course.routes.js"
    click LessonRoutes "https://github.com/momen165/devquest/blob/main/server/routes/lesson.routes.js"
    click CodeExecRoutes "https://github.com/momen165/devquest/blob/main/server/routes/codeExecution.routes.js"
    click PaymentRoutes "https://github.com/momen165/devquest/blob/main/server/routes/payment.routes.js"
    click UploadRoutes "https://github.com/momen165/devquest/blob/main/server/routes/upload.routes.js"
    click AuthCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/auth.controller.js"
    click CourseCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/course.controller.js"
    click LessonCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/lesson.controller.js"
    click CodeExecCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/codeExecution.controller.js"
    click PaymentCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/payment.controller.js"
    click UploadCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/upload.controller.js"
    click SubscrCtrl "https://github.com/momen165/devquest/blob/main/server/controllers/subscription.controller.js"
    click CourseModel "https://github.com/momen165/devquest/blob/main/server/models/course.model.js"
    click LessonModel "https://github.com/momen165/devquest/blob/main/server/models/lesson.model.js"
    click ActivityModel "https://github.com/momen165/devquest/blob/main/server/models/activity.js"
    click Migrations "https://github.com/momen165/devquest/tree/main/server/migrations"
    click S3Utils "https://github.com/momen165/devquest/blob/main/server/utils/s3.utils.js"
    click Logger "https://github.com/momen165/devquest/blob/main/server/utils/logger.js"
    click ErrorUtils "https://github.com/momen165/devquest/blob/main/server/utils/error.utils.js"
    click ValidationUtils "https://github.com/momen165/devquest/blob/main/server/utils/validation.utils.js"
    click XPBack "https://github.com/momen165/devquest/blob/main/server/utils/xpCalculator.js"

    %% Styles
    classDef frontend fill:#D6EAF8,stroke:#3498DB,color:#1B4F72;
    classDef backend fill:#FAD7A0,stroke:#E67E22,color:#873600;
    classDef database fill:#ABEBC6,stroke:#28B463,color:#145A32;
    classDef external fill:#F5B7B1,stroke:#CD6155,color:#78281F;
```
