# marouanebenfikri/mbenfikri architecture

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

- Interactive diagram: https://gitdiagram.com/marouanebenfikri/mbenfikri
- Repository: https://github.com/marouanebenfikri/mbenfikri

## Overview

##### Project type and purpose
- This is a static, front-end only Bootstrap-based landing-page template.
- A Gulp-driven build pipeline compiles SCSS and bundles JS, producing ready-to-serve HTML/CSS/JS under public_html.
- Users deploy it to any static web server or CDN to render a personal/commercial landing page.

##### File structure
- Top-level:
- gulpfile.js & package.json → Node/Gulp build configuration
- public_html/ → build output (HTML pages and assets)
- README.txt, LICENSE.txt, CV… → docs and licenses
- public_html/assets:
- scss/ → 7-1 pattern (abstracts, base, components, layout, vendors)
- css/ → compiled CSS (e.g. johndoe.css)
- js/ → custom JS (johndoe.js)
- imgs/ → videos and image assets
- HTML pages: index.html, components.html, details.html

##### README for insights
- External integrations: Unsplash demo images, Google Maps API

##### Components
a. Main components
- Source Directory (“src”): SCSS modules + custom JS
- Build System: Gulp tasks (compile SCSS → CSS, concat/minify JS)
- Output Directory (public_html): HTML pages + compiled assets
- Static Hosting: Web server or CDN that serves public_html
- Client Browser: Downloads HTML/CSS/JS, renders UI, invokes Google Maps API
- External Services:
– Google Maps API
– Unsplash (image hosting/demo images)
b. Relationships and interactions
1. Developer edits SCSS & JS → Gulp watches sources
2. Gulp processes:
- SCSS → CSS
- JS modules & vendor JS → bundled/minified JS
3. Output placed in public_html/assets
4. Web server serves HTML + assets to end-users
5. Browser loads static files, executes JS, applies CSS
6. JS may call external APIs (e.g., Google Maps) and lazy-load images (Unsplash)
c. Architectural patterns/design principles
- Front-end asset pipeline (build time vs runtime)
- Modular SCSS (7-1 pattern) for style separation
- Vendor vs custom code separation
- Static-site layering: source → build → deploy → client
d. Key technologies & libraries
- Node.js & Gulp (build orchestration)
- SCSS (preprocessor)
- Bootstrap 4.3.1 (layout & components)
- jQuery, Isotope (DOM manipulation & filtering)
- Google Maps API

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Source Code
    subgraph "Source Code"
        direction TB
        SCSS["SCSS Modules"]:::build
        JS_SRC["Custom JS Module"]:::build
        GULP_CFG["Gulp Configuration"]:::build
    end

    %% Vendor Libraries
    subgraph "Vendor Libraries"
        direction TB
        V_BOOT["Bootstrap JS/CSS"]:::vendor
        V_JQ["jQuery"]:::vendor
        V_ISO["Isotope"]:::vendor
        V_TI["Themify Icons"]:::vendor
    end

    %% Build Pipeline
    GULP_TASK["Gulp Build Pipeline"]:::build

    %% Build Output
    subgraph "Build Output (public_html)"
        direction TB
        subgraph "Assets"
            direction TB
            CSS_OUT["Compiled CSS"]:::output
            JS_OUT["Bundled/Minified JS"]:::output
            VEND_OUT["Vendor Assets"]:::vendor
        end
        subgraph "HTML Pages"
            direction TB
            INDEX["index.html"]:::output
            COMPONENTS["components.html"]:::output
            DETAILS["details.html"]:::output
        end
    end

    %% Deployment & Runtime
    HOST["Static Hosting (Web Server/CDN)"]:::output
    BROWSER["Client Browser"]:::runtime

    %% External Services
    subgraph "External Services"
        direction TB
        GMAP["Google Maps API"]:::runtime
        UNSPLASH["Unsplash Image CDN"]:::runtime
    end

    %% Connections
    SCSS -->|"watch & compile"| GULP_TASK
    JS_SRC -->|"bundle & minify"| GULP_TASK
    V_BOOT -->|"include"| GULP_TASK
    V_JQ -->|"include"| GULP_TASK
    V_ISO -->|"include"| GULP_TASK
    V_TI -->|"include"| GULP_TASK
    GULP_CFG -->|"configures"| GULP_TASK

    GULP_TASK -->|"output assets"| CSS_OUT
    GULP_TASK -->|"output assets"| JS_OUT
    GULP_TASK -->|"copy vendors"| VEND_OUT

    CSS_OUT --> HOST
    JS_OUT --> HOST
    VEND_OUT --> HOST
    INDEX --> HOST
    COMPONENTS --> HOST
    DETAILS --> HOST

    HOST -->|"serve static files"| BROWSER
    BROWSER -->|"load CSS/JS/HTML"| HOST
    BROWSER -->|"request maps"| GMAP
    BROWSER -->|"lazy-load images"| UNSPLASH

    %% Click Events
    click SCSS "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/assets/scss/"
    click JS_SRC "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/assets/js/johndoe.js"
    click GULP_CFG "https://github.com/marouanebenfikri/mbenfikri/blob/master/gulpfile.js"
    click GULP_CFG "https://github.com/marouanebenfikri/mbenfikri/blob/master/package.json"
    click CSS_OUT "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/assets/css/johndoe.css"
    click JS_OUT "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/assets/js/johndoe.js"
    click V_BOOT "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/assets/vendors/bootstrap/"
    click V_JQ "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/assets/vendors/jquery/"
    click V_ISO "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/assets/vendors/isotope/"
    click V_TI "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/assets/vendors/themify-icons/"
    click INDEX "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/index.html"
    click COMPONENTS "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/components.html"
    click DETAILS "https://github.com/marouanebenfikri/mbenfikri/blob/master/public_html/details.html"
    click HOST "https://github.com/marouanebenfikri/mbenfikri/tree/master/public_html/"

    %% Styles
    classDef build fill:#D6EAF8,stroke:#3498DB,color:#1B4F72
    classDef vendor fill:#F5EEF8,stroke:#8E44AD,color:#4A235A
    classDef output fill:#D5F5E3,stroke:#27AE60,color:#145A32
    classDef runtime fill:#FCF3CF,stroke:#F1C40F,color:#7D6608
```
