# glazovnick/test_employcity architecture

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

- Interactive diagram: https://gitdiagram.com/glazovnick/test_employcity
- Repository: https://github.com/glazovnick/test_employcity

## Overview

##### Project type and purpose
- This is a static, front-end–only web project that uses Gulp as a build system to compile SCSS, bundle assets, inject HTML partials, and output a ready-to-deploy site into the **dist/** folder.
- Purpose: deliver a responsive, interactive landing page (Test_Employcity) hosted on GitHub Pages.

##### File structure
- **app/** – all source files:
- index.html + HTML partials in **app/parts/**
- JavaScript entry in **app/js/app.js**
- Images in **app/images/**
- Styles in **app/styles/sass/** broken into config + blocks + UI components
- **dist/** – compiled output: HTML, CSS, JS, images, ready to serve.
- **gulpfile.js**, **package.json** – define build tasks, dependencies, scripts (`npm run dev`).
- **.bowerrc**, **.gitignore** – configure package management and ignore rules.

##### README for additional insights
- Lists tech stack: HTML5, CSS3/SCSS, Gulp, responsive layout (Flex/Grid), vanilla JS for animations.
- Notes deployment pipeline: compile → **dist/** → push to **gh-pages**.
- No backend or external services—pure static asset pipeline.

a. Main components:
1. Developer workstation (source code editor, Node.js)
2. Source code repository (GitHub)
3. Gulp build pipeline with tasks (SCSS compiler, HTML injector, minifier, asset copier)
4. Output folder (**dist/**)
5. Hosting platform (GitHub Pages)
b. Relationships and data flow:
- Developers push/pull to GitHub.
- `npm run dev` / `gulp` reads **app/** → processes files → writes **dist/**.
- CI or manual push of **dist/** to **gh-pages** branch → GitHub Pages serves site.
c. Architectural patterns/principles:
- Build pipeline (task runner) pattern
- Modular SCSS architecture (config + blocks + UI components)
- Partial injection for DRY HTML
- Single-page asset bundling (no multi-page routing)
d. Key technologies/frameworks:
- Node.js + npm for dependency management
- Gulp for automation (plugins for Sass, HTML partials, image copying, minification)
- SCSS for style modularity
- Vanilla JS for DOM animations

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Workflow
    subgraph "Developer Workflow"
        Dev["Developer Workstation"]:::external
        Dev -->|push/pull| Repo[(GitHub Repo)]:::external
        Dev -->|"npm run dev / gulp"| GulpTrigger{{"npm run dev / gulp"}}:::build
    end

    %% Source Files
    subgraph "Source (app/)" 
        direction TB
        HTML["index.html"]:::source
        PartialsHeader["header.html"]:::source
        PartialsFooter["footer.html"]:::source
        JS["app.js"]:::source
        SCSSConfig["_config.scss"]:::source
        subgraph "SCSS Blocks"
            General["_general.scss"]:::source
            HeaderBlk["_header.scss"]:::source
            FooterBlk["_footer.scss"]:::source
            Order["_order.scss"]:::source
            Preview["_preview.scss"]:::source
        end
        subgraph "SCSS UI Components"
            Btn["_button.scss"]:::source
            Input["_input.scss"]:::source
            Progress["_progress.scss"]:::source
            Select["_select.scss"]:::source
        end
        MainSCSS["main.scss"]:::source
        Images["app/images"]:::source
        ConfigFiles["package.json & .bowerrc"]:::source
        Docs["readme.md"]:::source
    end

    %% Gulp Pipeline Tasks
    subgraph "Gulp Build Pipeline"
        direction TB
        SCSSCompile["Compile SCSS → main.css"]:::build
        HTMLInject["Inject HTML Partials"]:::build
        Minify["Minify CSS/JS"]:::build
        CopyAssets["Copy Images & JS"]:::build
    end

    %% Outputs
    subgraph "Output (dist/)"
        direction TB
        DistHTML["dist/index.html"]:::output
        DistCSS["dist/css/"]:::output
        DistJS["dist/js/"]:::output
        DistImages["dist/images/"]:::output
    end

    %% Hosting
    GHPages[/"GitHub Pages"/]:::external

    %% Flows: Source to Pipeline
    HTML -->|input| HTMLInject
    PartialsHeader -->|partials| HTMLInject
    PartialsFooter -->|partials| HTMLInject
    JS -->|input| CopyAssets
    Images -->|input| CopyAssets
    SCSSConfig -->|config| SCSSCompile
    General -->|blocks| SCSSCompile
    HeaderBlk -->|blocks| SCSSCompile
    FooterBlk -->|blocks| SCSSCompile
    Order -->|blocks| SCSSCompile
    Preview -->|blocks| SCSSCompile
    Btn -->|ui comp| SCSSCompile
    Input -->|ui comp| SCSSCompile
    Progress -->|ui comp| SCSSCompile
    Select -->|ui comp| SCSSCompile
    MainSCSS -->|entry| SCSSCompile
    ConfigFiles -->|cfg| GulpTrigger

    %% Pipeline to Outputs
    SCSSCompile -->|writes| DistCSS
    SCSSCompile -->|writes| DistJS
    HTMLInject -->|writes| DistHTML
    Minify -->|optimizes| DistCSS
    Minify -->|optimizes| DistJS
    CopyAssets -->|copies| DistImages

    %% Deployment
    DistHTML -->|artifact| GHPages
    DistCSS -->|artifact| GHPages
    DistJS -->|artifact| GHPages
    DistImages -->|artifact| GHPages

    %% Click Events
    click HTML "https://github.com/glazovnick/test_employcity/blob/main/app/index.html"
    click PartialsHeader "https://github.com/glazovnick/test_employcity/blob/main/app/parts/header.html"
    click PartialsFooter "https://github.com/glazovnick/test_employcity/blob/main/app/parts/footer.html"
    click JS "https://github.com/glazovnick/test_employcity/blob/main/app/js/app.js"
    click SCSSConfig "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/_config.scss"
    click General "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/_general.scss"
    click HeaderBlk "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/_header.scss"
    click FooterBlk "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/_footer.scss"
    click Order "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/_order.scss"
    click Preview "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/_preview.scss"
    click Btn "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/ui/_button.scss"
    click Input "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/ui/_input.scss"
    click Progress "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/ui/_progress.scss"
    click Select "https://github.com/glazovnick/test_employcity/blob/main/app/styles/sass/blocks/ui/_select.scss"
    click MainSCSS "https://github.com/glazovnick/test_employcity/blob/main/app/styles/main.scss"
    click Images "https://github.com/glazovnick/test_employcity/tree/main/app/images"
    click ConfigFiles "https://github.com/glazovnick/test_employcity/blob/main/package.json"
    click ConfigFiles "https://github.com/glazovnick/test_employcity/blob/main/.bowerrc"
    click Docs "https://github.com/glazovnick/test_employcity/blob/main/readme.md"
    click DistHTML "https://github.com/glazovnick/test_employcity/blob/main/dist/index.html"
    click DistCSS "https://github.com/glazovnick/test_employcity/tree/main/dist/css/"
    click DistJS "https://github.com/glazovnick/test_employcity/tree/main/dist/js/"
    click DistImages "https://github.com/glazovnick/test_employcity/tree/main/dist/images/"

    %% Styles
    classDef source fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef build fill:#90EE90,stroke:#000,stroke-width:1px
    classDef output fill:#FFFF99,stroke:#000,stroke-width:1px
    classDef external fill:#FFA500,stroke:#000,stroke-width:1px
```
