# artiebears13/2024-2-vk-edu-frontend-a-medvedev architecture

> Architecture diagram of the GitHub repository artiebears13/2024-2-vk-edu-frontend-a-medvedev, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev
- Repository: https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev

## Overview

##### Project type and purpose
- This repository is an educational monorepo (“2024-2-VK-EDU-Frontend-A-Medvedev”) containing three distinct front-end React/Vite or Webpack projects (exam, react-chat, simple-chat) plus a Node.js exercise (homework1).
- Each folder is a self-contained demo or assignment illustrating common front-end features: translation form (exam), real-time chat via Centrifugo (react-chat), vanilla JS chat (simple-chat), and algorithmic utilities (homework1).

##### File structure
- Top-level: .github (CI/CD), .husky (git hooks), root package.json (possibly for shared tooling), pull_request_template.md.
- exam: a TypeScript React/Vite translation app with Redux Toolkit, SCSS, and a call to an external translation API.
- react-chat: a full-blown React/Vite chat app using REST endpoints + Centrifugo WebSocket, Redux slices + middleware, SCSS modules, context, hooks.
- simple-chat: a lighter Webpack-based vanilla JS chat demo, SCSS for styling, a mock layer.
- homework1: Node.js scripts and Jest tests for pure-function exercises.

##### Readme insights
- Short description “Учебный проект” confirms this is a learning sandbox, no single unified service—each folder is its own mini-service.

a. Monorepo management layer
– CI/CD (.github/workflows), shared lint/pre-commit (.husky), shared package scripts.
b. Exam app
– Browser UI (React components → App.tsx)
– Redux store (translationSlice)
– TranslationService (utils/translate.ts) → external Translation API
– Assets & SCSS modules
c. React-chat app
– Browser UI (React components + pages)
– State management
- Redux store (chatSlice, messageSlice, userSlice)
- Middlewares: centrifugoMiddleware (WebSocket), notificationMiddleware
– API layer (src/api + src/apiTS)
- REST endpoints for users, chats, messages
- Centrifugo for real-time push
– Context/ErrorContext, custom hooks, mock layer for tests
– SCSS modules
d. Simple-chat app
– Browser UI (vanilla JS modules + SCSS)
– Mock WebSocket/REST service (in mocks)
– Webpack bundler
e. Homework1
– Node.js functions and test harness (Jest)

##### Relationships and interactions
- Monorepo root coordinates CI, lint, format across all sub-projects.
- Each subfolder is built & deployed independently:
- exam & react-chat use Vite → hot reload, dev server → production build
- simple-chat uses Webpack
- homework1 runs via Node/Jest CLI
- At runtime:
- exam → sends HTTP requests to Translation API → updates Redux store → re-renders UI
- react-chat → on load: REST “login/register” calls → store user → open WebSocket (Centrifugo) via middleware → dispatch inbound events → update UI → send outbound messages via REST or WS
- simple-chat → directly opens WebSocket / HTTP mocks → updates DOM

##### Architectural patterns & design principles
- exam: unidirectional data flow (React + Redux Toolkit), component isolation, SCSS modularization
- react-chat: Flux architecture (Redux slices + middleware), separation of concerns between API adapters & business logic, context for cross-cutting concerns (errors), custom hooks
- simple-chat: modular JS, MVC-like separation between view (chatWindow, chatList) and data (mocks)
- homework1: pure functions + test-driven design

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Monorepo Management Layer
    subgraph "Monorepo Management Layer"
        direction TB
        CI_CD["CI/CD Workflows"]:::monorepo
        GitHooks["Git Hooks (pre-commit)"]:::monorepo
        RootTooling["Root Tooling & Scripts"]:::monorepo
    end

    CI_CD -->|uses| GitHooks
    GitHooks -->|configured by| RootTooling

    %% Exam App
    subgraph "Exam App (React + Vite translation demo)" 
        direction TB
        ExamRoot["exam/package.json"]:::exam
        Entry["main.tsx + index.html"]:::exam
        AppComp["App.tsx + App.scss"]:::exam
        Components["Feature Components"]:::exam
        Store["Store Setup (translationSlice)"]:::exam
        Service["Translation Service"]:::exam
        Styles["Global Styles & Assets"]:::exam
        Utils["Utilities & Types"]:::exam
    end

    ExamRoot --> Entry
    Entry --> AppComp
    AppComp --> Components
    Components --> Store
    Store --> Service
    Service -->|calls| ExtAPI["Translation API"]:::external
    AppComp --> Styles
    AppComp --> Utils

    %% React-Chat App
    subgraph "React-Chat App (React + Vite real-time chat)" 
        direction TB
        ChatRoot["react-chat/package.json"]:::reactChat
        ChatEntry["main.jsx + index.html"]:::reactChat
        ChatApp["App.jsx + App.css"]:::reactChat
        ChatPages["Pages"]:::reactChat
        ChatComps["Reusable Components"]:::reactChat
        ChatStore["Store Setup + Slices"]:::reactChat
        ChatMW["Middlewares"]:::reactChat
        APIJS["API Layer (JS & TS Adapters)"]:::reactChat
        Context["Error Context & Hooks"]:::reactChat
        MockLayer["Mock Layer"]:::reactChat
        ChatStyles["Styles & Assets"]:::reactChat
    end

    ChatRoot --> ChatEntry
    ChatEntry --> ChatApp
    ChatApp --> ChatPages
    ChatApp --> ChatComps
    ChatPages --> ChatStore
    ChatComps --> ChatStore
    ChatStore --> ChatMW
    ChatMW --> Centrifugo["Centrifugo Service"]:::external
    ChatStore --> APIJS
    APIJS --> ExtREST["REST API"]:::external
    ChatApp --> Context
    ChatApp --> ChatStyles
    ChatApp --> MockLayer

    %% Simple-Chat App
    subgraph "Simple-Chat App (Vanilla JS + Webpack chat demo)"
        direction TB
        SimpleRoot["simple-chat/package.json"]:::simpleChat
        SimpleEntry["index.js + index.html"]:::simpleChat
        SimpleComps["Components"]:::simpleChat
        SimpleMocks["Mock Services"]:::simpleChat
        SimpleUtils["Utilities & Styles"]:::simpleChat
        Bundler["Webpack"]:::simpleChat
    end

    SimpleRoot --> Bundler
    Bundler --> SimpleEntry
    SimpleEntry --> SimpleComps
    SimpleEntry --> SimpleMocks
    SimpleEntry --> SimpleUtils

    %% Homework1 Node.js Exercise
    subgraph "Homework1 (Node.js functions & Jest tests)"
        direction TB
        HWRoot["homework1/package.json"]:::homework
        Functions["Source Functions"]:::homework
        Tests["Test Harness (Jest)"]:::homework
    end

    HWRoot --> Functions
    HWRoot --> Tests
    Tests --> Functions

    %% Root connections
    GitHooks --> ExamRoot
    GitHooks --> ChatRoot
    GitHooks --> SimpleRoot
    GitHooks --> HWRoot

    %% Click Events
    click CI_CD "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/.github/workflows/gh-pages.yml"
    click GitHooks "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/tree/master/.husky/pre-commit"
    click RootTooling "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/package.json"
    click ExamRoot "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/exam/package.json"
    click Entry "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/exam/src/main.tsx"
    click AppComp "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/exam/src/App.tsx"
    click Store "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/exam/src/store/index.ts"
    click Service "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/exam/src/utils/translate.ts"
    click ChatRoot "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/package.json"
    click ChatEntry "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/src/main.jsx"
    click ChatApp "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/src/App.jsx"
    click ChatStore "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/src/store/store.js"
    click ChatMW "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/src/store/centrifugoMiddleware.js"
    click APIJS "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/react-chat/src/api/api.js"
    click SimpleRoot "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/simple-chat/package.json"
    click SimpleEntry "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/simple-chat/src/index.js"
    click HWRoot "https://github.com/artiebears13/2024-2-vk-edu-frontend-a-medvedev/blob/master/homework1/package.json"

    %% Styles
    classDef monorepo fill:#D8BFD8,stroke:#9370DB,color:#000
    classDef exam fill:#ADD8E6,stroke:#1E90FF,color:#000
    classDef reactChat fill:#98FB98,stroke:#32CD32,color:#000
    classDef simpleChat fill:#FFE4B5,stroke:#FF8C00,color:#000
    classDef homework fill:#D3D3D3,stroke:#808080,color:#000
    classDef external fill:#F0E68C,stroke:#DAA520,color:#000
```
