# patelnildip/myprofile architecture

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

- Interactive diagram: https://gitdiagram.com/patelnildip/myprofile
- Repository: https://github.com/patelnildip/myprofile

## Overview

##### Project type and purpose
- This is a static, personal-profile website (JAMstack architecture) hosted on GitHub Pages.
- It uses Jekyll as the static-site generator, SCSS for styling, third-party CSS/JS libraries, and plain HTML/JS/CSS for the front end.
- The README confirms it’s a GitHub Pages site rebuilt via Jekyll on each push, with content in Markdown and styling via SCSS/Bootstrap.

##### File structure
- Top-level files and dirs:
- index.html – the entry point for the browser
- README.md & _config.yml – Jekyll config and documentation
- /css, /js, /images, /fonts – static asset folders
- /scss – source styles, including Bootstrap overrides and custom SCSS
- /lib – vendor CSS/JS/frameworks (Animate.css, AOS, Bootstrap, jQuery plugins, etc.)
- prepros-6.config – local SCSS compilation settings
- No backend code or API services—purely static.
- Build step: SCSS → CSS, Jekyll templates/Markdown → HTML, bundling of CSS/JS assets.

##### README for additional insights
- Project uses GitHub’s Jekyll pipeline.

##### Components
a. Developer Environment
– Source code repo (GitHub) containing HTML, SCSS, JS, Markdown.
– Local dev tool (Prepros or similar) that compiles SCSS to CSS.
b. CI/CD / Build Pipeline
– GitHub Actions (or GitHub Pages built-in) triggers Jekyll build on push.
– Jekyll engine processes layouts, includes, Markdown → static HTML.
– SCSS compiler (could be a step in Jekyll or external tool) → final CSS files.
c. Hosting
– GitHub Pages serves generated files over HTTPS as a CDN.
d. Browser & External Services
– User’s web browser requests index.html and assets from GitHub Pages.
– Front-end JS interacts with Google Maps API (google-map.js) and any other client-side plugins (AOS, Magnific Popup).
e. Static Assets
– CSS, JS, images, fonts delivered directly from the same origin (GitHub Pages) or via CDN, if configured.

##### Relationships and interactions
- Developer → pushes code → GitHub Repo.
- GitHub Repo → triggers Jekyll build → generates /_site with HTML/CSS/JS.
- GitHub Pages → serves /_site files → User’s Browser.
- Browser → downloads index.html → pulls in CSS, JS, fonts, images.
- Browser JS → calls external APIs (Google Maps, AOS animations).

##### Architectural patterns & design principles
- JAMstack (pre-build, CDN-served static content).
- Asset pipeline: SCSS modularization, Bootstrap overrides, vendor libs in /lib.
- Progressive enhancement: no server-side logic, behavior via client-side JS.
- Separation of concerns: content (Markdown), layout (HTML templates), styling (SCSS), behavior (JS).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Developer and Repo
    Developer["Developer"]:::dev
    Repo["GitHub Repo"]:::repo
    Developer -->|push code| Repo

    %% Source Code in Repo
    subgraph "Source Code"
        direction TB
        IndexSrc["index.html"]:::source
        ConfigFile["_config.yml"]:::source
        Readme["README.md"]:::source
        PreprosCfg["prepros-6.config"]:::build
        SCSS["scss/style.scss"]:::source
        SCSSBoot["scss/bootstrap/"]:::source
        Lib["lib/"]:::source
        JSMain["js/main.js"]:::source
        JSMap["js/google-map.js"]:::source
        JSAOS["js/aos.js"]:::source
        JSEase["js/jquery.easing.1.3.js"]:::source
        ImagesSrc["images/"]:::source
        FontsSrc["fonts/"]:::source
    end

    %% Build Pipeline
    subgraph "Build Pipeline"
        direction TB
        Prepros["Prepros (SCSS Compiler)"]:::build
        Jekyll["Jekyll Engine"]:::build
    end

    Repo -->|trigger build| Prepros
    Repo -->|trigger build| Jekyll

    SCSS --> Prepros
    SCSSBoot --> Prepros

    ConfigFile --> Jekyll
    Readme --> Jekyll

    Lib --> Jekyll
    JSMain --> Jekyll
    JSMap --> Jekyll
    JSAOS --> Jekyll
    JSEase --> Jekyll
    ImagesSrc --> Jekyll
    FontsSrc --> Jekyll
    IndexSrc --> Jekyll

    %% Generated Site
    subgraph "Generated Site (_site)"
        direction TB
        SiteIndex["index.html"]:::output
        SiteCSS["css/style.css\ncss/bootstrap/..."]:::output
        SiteJSMain["js/main.js"]:::output
        SiteJSMap["js/google-map.js"]:::output
        SiteJSAOS["js/aos.js"]:::output
        SiteJSEase["js/jquery.easing.1.3.js"]:::output
        SiteLib["lib/..."]:::output
        SiteImages["images/"]:::output
        SiteFonts["fonts/"]:::output
    end

    Prepros -->|compiles CSS| SiteCSS
    Jekyll -->|generates HTML & copies assets| SiteIndex
    Jekyll --> SiteJSMain
    Jekyll --> SiteJSMap
    Jekyll --> SiteJSAOS
    Jekyll --> SiteJSEase
    Jekyll --> SiteLib
    Jekyll --> SiteImages
    Jekyll --> SiteFonts

    %% Deployment
    Pages["GitHub Pages CDN"]:::cdn
    SiteIndex -->|deploy| Pages
    SiteCSS --> Pages
    SiteJSMain --> Pages
    SiteJSMap --> Pages
    SiteJSAOS --> Pages
    SiteJSEase --> Pages
    SiteLib --> Pages
    SiteImages --> Pages
    SiteFonts --> Pages

    %% Browser and External Services
    Browser["User Browser"]:::browser
    Pages -->|serve files| Browser
    Browser -->|load index.html, CSS, JS, images, fonts| SiteIndex
    Browser -->|API calls| GoogleMaps["Google Maps API"]:::external
    Browser -->|animation & UI| AOS["AOS, Magnific Popup, etc."]:::external

    %% Click Events
    click IndexSrc "https://github.com/patelnildip/myprofile/blob/master/index.html"
    click ConfigFile "https://github.com/patelnildip/myprofile/blob/master/_config.yml"
    click Readme "https://github.com/patelnildip/myprofile/blob/master/README.md"
    click PreprosCfg "https://github.com/patelnildip/myprofile/blob/master/prepros-6.config"
    click SCSS "https://github.com/patelnildip/myprofile/blob/master/scss/style.scss"
    click SCSSBoot "https://github.com/patelnildip/myprofile/tree/master/scss/bootstrap/"
    click Lib "https://github.com/patelnildip/myprofile/tree/master/lib/"
    click JSMain "https://github.com/patelnildip/myprofile/blob/master/js/main.js"
    click JSMap "https://github.com/patelnildip/myprofile/blob/master/js/google-map.js"
    click JSAOS "https://github.com/patelnildip/myprofile/blob/master/js/aos.js"
    click JSEase "https://github.com/patelnildip/myprofile/blob/master/js/jquery.easing.1.3.js"
    click ImagesSrc "https://github.com/patelnildip/myprofile/tree/master/images/"
    click FontsSrc "https://github.com/patelnildip/myprofile/tree/master/fonts/"
    click SiteCSS "https://github.com/patelnildip/myprofile/blob/master/css/style.css"
    click SiteJSMain "https://github.com/patelnildip/myprofile/blob/master/js/main.js"
    click SiteJSMap "https://github.com/patelnildip/myprofile/blob/master/js/google-map.js"
    click SiteJSAOS "https://github.com/patelnildip/myprofile/blob/master/js/aos.js"
    click SiteJSEase "https://github.com/patelnildip/myprofile/blob/master/js/jquery.easing.1.3.js"

    %% Styles
    classDef dev fill:#ffd700,stroke:#333,stroke-width:2px;
    classDef repo fill:#add8e6,stroke:#333,stroke-width:2px;
    classDef source fill:#f0f8ff,stroke:#333,stroke-width:2px;
    classDef build fill:#87cefa,stroke:#333,stroke-width:2px;
    classDef output fill:#90ee90,stroke:#333,stroke-width:2px;
    classDef cdn fill:#32cd32,stroke:#333,stroke-width:2px;
    classDef browser fill:#ffa500,stroke:#333,stroke-width:2px;
    classDef external fill:#ff8c00,stroke:#333,stroke-width:2px;
```
