# elevateedorg/elevateed-frontend-web architecture

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

- Interactive diagram: https://gitdiagram.com/elevateedorg/elevateed-frontend-web
- Repository: https://github.com/elevateedorg/elevateed-frontend-web

## Overview

##### Project type and purpose
- This is a Single-Page Application (SPA) front-end for an e-learning platform, built with React, TypeScript, and Vite.
- It provides authentication flows, course browsing/enrollment, chat support, instructor listings, user profile & dashboard pages.

##### File structure
- Top-level files & folders:
- package.json, vite.config.ts, ESLint configs → build & tooling
- public & index.html → static assets & host page
- src/ → all source:
– src/pages/ → route-level React components
– src/components/ → reusable UI blocks grouped by feature (Auth, Course, ChatWidget, Navbar, etc.)
– src/api/ → HTTP service modules (authService.ts, courseService.ts)
– src/redux/ → global state management (store.ts, slices)
– src/lib/ → shared utilities (axios wrapper, helpers)
– src/hooks/ → custom hooks (e.g., useMobile)
– src/assets/ → images & media imports
– src/types/ → TypeScript type declarations
- Architectural patterns:
- Component-driven (feature folders)
- Unidirectional data flow (React → Redux → API → Redux → React)
- Separation of concerns: UI vs. state vs. network vs. utilities

##### README for additional insights
- It’s the default Vite + React + TypeScript template.
- No built-in backend—API endpoints will be external services.
- ESLint config is pluggable for TypeScript-aware linting but not central to runtime design.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% DevOps & Build
    subgraph "DevOps & Build"
        Git["Git Repo"]:::tool
        ViteCfg["vite.config.ts"]:::tool
        TSConfig["tsconfig.json"]:::tool
        Package["package.json"]:::tool
        Git --> ViteBuild["Vite Build"]:::process
        ViteCfg --> ViteBuild
        TSConfig --> ViteBuild
        Package --> ViteBuild
        ViteBuild --> Deploy["Deployment"]:::process
    end

    %% Browser (Client)
    subgraph "Browser (Client)"
        subgraph "Entry"
            Main["main.tsx"]:::core
            App["App.tsx"]:::core
        end
        Main --> App

        subgraph "UI Layer"
            Pages["Route-Level Pages"]:::ui
            AuthComp["Auth Components"]:::ui
            CourseComp["Course Components"]:::ui
            ChatWidgetComp["ChatWidget Components"]:::ui
            NavbarComp["Navbar Components"]:::ui
            CarouselComp["Carousel Components"]:::ui
            DashboardComp["Dashboard Components"]:::ui
            FooterComp["Footer Component"]:::ui
            InstructorComp["Instructor Components"]:::ui
            UIPrimitives["UI Primitives"]:::ui
        end

        subgraph "State Management"
            Store["Store"]:::state
            CartSlice["cartSlice"]:::state
            ChatSlice["chatSlice"]:::state
            UserSlice["userSlice"]:::state
        end

        subgraph "API Layer"
            AuthService["authService"]:::api
            CourseService["courseService"]:::api
        end

        subgraph "Utilities & Hooks"
            Axios["Axios Wrapper"]:::util
            Utils["Utility Functions"]:::util
            Hooks["Custom Hooks"]:::util
        end

        subgraph "Assets"
            CourseBanners["Course Banners"]:::asset
            InstructorImgs["Instructor Images"]:::asset
            LoginBg["Login Background"]:::asset
        end

        %% Data Flows
        App --> UIPrimitives
        Pages --> Store
        AuthComp --> Store
        CourseComp --> Store
        ChatWidgetComp --> Store
        NavbarComp --> Store
        CarouselComp --> Store
        DashboardComp --> Store
        FooterComp --> Store
        InstructorComp --> Store

        Store --> CartSlice
        Store --> ChatSlice
        Store --> UserSlice

        CartSlice --> AuthService
        ChatSlice --> AuthService
        ChatSlice --> CourseService
        UserSlice --> AuthService

        AuthService -->|HTTP| AuthAPI["Auth API Server"]:::external
        CourseService -->|HTTP| CourseAPI["Course Management API"]:::external
        ChatSlice --> Axios
        Axios -->|WS/HTTP| ChatAPI["Chat WebSocket/API"]:::external

        Utils --> AuthService
        Axios --> CourseService
        Hooks --> UIPrimitives

        CourseBanners -->|fetch| CDN["CDN/Cloud Storage"]:::external
        InstructorImgs -->|fetch| CDN
        LoginBg -->|fetch| CDN
    end

    %% External Services
    AuthAPI
    CourseAPI
    ChatAPI
    CDN
    Analytics["Analytics/Logging"]:::external

    %% Click Events
    click Pages "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/pages"
    click AuthComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Auth"
    click CourseComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Course"
    click ChatWidgetComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/ChatWidget"
    click NavbarComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Navbar"
    click CarouselComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Carousel"
    click DashboardComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Dashboard"
    click FooterComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Footer"
    click InstructorComp "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/Instructor"
    click UIPrimitives "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/components/ui"
    click Store "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/redux/store.ts"
    click CartSlice "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/redux/slices/cartSlice.ts"
    click ChatSlice "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/redux/slices/chatSlice.ts"
    click UserSlice "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/redux/slices/userSlice.ts"
    click AuthService "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/api/authService.ts"
    click CourseService "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/api/courseService.ts"
    click Axios "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/lib/axios.ts"
    click Utils "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/lib/utils.ts"
    click Hooks "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/hooks/use-mobile.ts"
    click CourseBanners "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/assets/courseBanners"
    click InstructorImgs "https://github.com/elevateedorg/elevateed-frontend-web/tree/master/src/assets/instructors"
    click LoginBg "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/public/login_bg.avif"
    click Main "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/main.tsx"
    click App "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/src/App.tsx"
    click ViteCfg "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/vite.config.ts"
    click TSConfig "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/tsconfig.json"
    click Package "https://github.com/elevateedorg/elevateed-frontend-web/blob/master/package.json"

    %% Styles
    classDef tool fill:#CCCCCC,stroke:#333333;
    classDef process fill:#EEEEEE,stroke:#666666;
    classDef core fill:#B3D4FC,stroke:#003366;
    classDef ui fill:#CCE5FF,stroke:#003366;
    classDef state fill:#D5F5E3,stroke:#145A32;
    classDef api fill:#FDEBD0,stroke:#B9770E;
    classDef util fill:#E8DAEF,stroke:#6C3483;
    classDef asset fill:#F9E79F,stroke:#9A7D0A;
    classDef external fill:#D6EAF8,stroke:#1B4F72;
```
