# shyamjos/wedding-website architecture

> Architecture diagram of the GitHub repository shyamjos/wedding-website, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-02-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shyamjos/wedding-website
- Repository: https://github.com/shyamjos/wedding-website

## Overview

##### Project type and purpose (what you’re diagramming)
This repo is a **static wedding website** based on a FreeHTML5 Bootstrap template. It’s not a traditional “system” with backend services; it’s primarily:
- **A single-page/static site** (`index.html`)
- **Static assets** (CSS, JS, images, fonts)
- Some **client-side interactive behavior** (countdown clock, Google Map integration, animations, popup/gallery behavior)
- **Optional build/preprocess layer** via **Sass** sources (the `sass/` folder) that compile into `css/`

- **Static hosting + CDN** (how the site is served)
- **Browser runtime components** (HTML/CSS/JS and third-party libraries)
- **External services** used client-side (Google Maps, possibly CDN libraries if referenced in HTML)

##### Top-level runtime entrypoint
- `index.html`
The main (likely only) page. This is where dependencies are wired: CSS links, JS script tags, HTML sections, map container, countdown container, etc.

##### Client-side behavior layer
- `js/`
JavaScript executed in the browser:
- `js/main.js` likely initializes theme behaviors, scrolling, animations, event handlers.
- `js/clock.js` implements the **countdown**; README calls out the target date/timezone via `moment.tz(...)`.
- `js/google_map.js` integrates **Google Maps** (or a map embed API).
- `jquery.countTo.js`, `jquery.easing.1.3.js` are animation/count utilities.
- `magnific-popup-options.js` configures popup plugin.
- `simplyCountdown.js` countdown library (clock.js may configure it).

##### Static media assets
- `images/` (site images)

##### Hosting/domain config
- `CNAME` indicates **GitHub Pages custom domain** usage (common pattern).
- `.github/` funding file is irrelevant to runtime architecture.

##### README insights to incorporate
- Site is deployed at `https://we.shyamjos.com/`
- It’s based on a **Bootstrap wedding template**
- The countdown is configured in `js/clock.js` with `moment-timezone` style API (`moment.tz(...)`), implying a **client-side date/time library**.

This tells you to explicitly show:
- Countdown depends on **moment + moment-timezone** (either vendored, or pulled via CDN—confirm in `index.html`)
- Timezone-sensitive client logic is part of the browser runtime

##### Static Hosting: GitHub Pages (implied by `CNAME`) or equivalent static host

**Client Runtime (Browser)**
##### CSS layer
- Bootstrap CSS (`css/bootstrap.css`)
- Theme/site CSS (`css/style.css`, `css/responsive-clock.css`)
- Plugin CSS (`animate.css`, `flexslider.css`, `magnific-popup.css`, `icomoon.css`)
##### JS runtime
- Theme bootstrapper: `js/main.js`
- Countdown module: `js/clock.js` + `js/simplyCountdown.js`
- Module: `js/google_map.js`
- Effects/utilities: `jquery.easing.1.3.js`, `jquery.countTo.js`
- Popup config: `magnific-popup-options.js`
##### Static assets
- Images: `images/`

**External Services (called from client-side JS)**
##### Google Maps API (invoked by `js/google_map.js`)
9. **3rd-party JS libraries** (jQuery, Bootstrap JS, Moment/Moment-timezone, Magnific Popup, Flexslider, etc.)
As:
- “Bundled locally in /js” if present
- Or “Loaded from CDN” if referenced externally in `index.html`

**Build-time (optional, but should be shown separately as “developer workflow”)**
##### Sass toolchain: `sass/` → outputs to `css/`
- Inputs: `sass/style.scss`, `sass/bootstrap/**/*.scss`
- Outputs: `css/style.css`, `css/bootstrap.css` (depending on how they build)

**Request/Response flow**
- User Browser → DNS (`we.shyamjos.com`) → Static Host (GitHub Pages)
- Static Host → Browser: returns `index.html`
- Browser → Static Host: fetches `/css/*`, `/js/*`, `/images/*`, `/fonts/*`

**Runtime execution flow**
- `index.html` → loads CSS files (render pipeline)
- `index.html` → loads JS files (script execution)
- `js/main.js` → initializes UI behavior (animations/scroll/popup triggers)
- `js/clock.js` → uses `simplyCountdown.js` and `moment.tz` to compute countdown and update DOM
- `js/google_map.js` → calls Google Maps API → renders map in a DOM container

**External calls**

##### Architectural patterns / design principles
- **Static site architecture**: no backend, no database; everything served as files.
- **Theme/plugin composition**: main page orchestrates multiple JS/CSS plugins.
- **Separation of concerns**:
- `index.html` as composition root
- `css/` for presentation
- `js/` for behavior
- `images/`, `fonts/` for assets
- **Build vs runtime split**:
- Sass exists for maintainability (build-time)
- Compiled CSS is what ships (runtime)

##### Call out relevant technologies
From file tree + README:
- HTML5 + CSS + JavaScript
- Bootstrap (CSS framework)
- Sass (preprocessor)
- jQuery ecosystem plugins (countTo, easing)
- Magnific Popup
- Flexslider
- Moment.js + moment-timezone usage (implied by `moment.tz(...)`)
- Google Maps API integration

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =======================
  %% Diagram 1: Delivery / Runtime Context (Static Site)
  %% =======================
  subgraph "Delivery & Runtime Context (Static Wedding Website)"
    direction TB

    U["Guest User"]:::person
    B["Web Browser"]:::client

    subgraph "Domain & Hosting"
      direction TB
      DNS["DNS: we.shyamjos.com"]:::infra
      EDGE["Edge Cache / CDN Layer"]:::infra
      HOST["Static Host: GitHub Pages"]:::infra
      SITE["Wedding Website (Static Files)"]:::infra
    end

    subgraph "External Services"
      direction TB
      GMAPS["Google Maps API"]:::external
      CDNJS["3rd-party CDN (optional)"]:::external
    end

    U -->|"visits"| B
    B -->|"resolves_domain"| DNS
    DNS -->|"routes_to"| EDGE
    EDGE -->|"serves_from"| HOST
    HOST -->|"hosts"| SITE

    SITE -->|"delivers_index+assets"| B
    B -->|"map_requests"| GMAPS
    B -.->|"optional_library_fetch"| CDNJS
  end

  %% =======================
  %% Diagram 2: Browser Composition (index.html + assets)
  %% =======================
  subgraph "Browser Runtime (Client-Side Composition)"
    direction TB

    INDEX["index.html (Composition Root)"]:::frontend

    subgraph "Styling Layer (CSS)"
      direction TB
      CSSDIR["css/ (Compiled CSS)"]:::frontend
      BOOTCSS["bootstrap.css"]:::frontend
      THEMECSS["style.css"]:::frontend
      CLOCKCSS["responsive-clock.css"]:::frontend
      ANIMCSS["animate.css"]:::frontend
      FLEXCSS["flexslider.css"]:::frontend
      POPCSS["magnific-popup.css"]:::frontend
      ICOMOONCSS["icomoon.css"]:::frontend
    end

    subgraph "Behavior Layer (JavaScript)"
      direction TB
      JSDIR["js/ (Client-side JS)"]:::frontend

      MAIN["main.js (Theme initialization)"]:::frontend

      subgraph "Countdown Feature"
        direction TB
        CLOCK["clock.js (Countdown module)"]:::frontend
        SIMPLY["simplyCountdown.js (Countdown library)"]:::frontend
        MOMENT["moment + moment-timezone (runtime lib)"]:::external
      end

      subgraph "Map Feature"
        direction TB
        GMAPJS["google_map.js (Map integration)"]:::frontend
        GMAPAPI["Google Maps API"]:::external
      end

      subgraph "Plugins / Utilities"
        direction TB
        EASING["jquery.easing.1.3.js"]:::frontend
        COUNTTO["jquery.countTo.js"]:::frontend
        POPCONF["magnific-popup-options.js"]:::frontend
        JQ["jQuery (runtime lib)"]:::external
        BSJS["Bootstrap JS (runtime lib)"]:::external
        MAGLIB["Magnific Popup (runtime lib)"]:::external
        FLEXLIB["Flexslider (runtime lib)"]:::external
      end
    end

    subgraph "Static Assets"
      direction TB
      IMGDIR["images/"]:::asset
      FONTSDIR["fonts/"]:::asset
      FBOOT["fonts/bootstrap/ (Glyphicons)"]:::asset
      FICO["fonts/icomoon/ (Icon fonts)"]:::asset
    end

    %% Load relationships from index.html
    INDEX -->|"links_css"| CSSDIR
    CSSDIR -->|"includes"| BOOTCSS
    CSSDIR -->|"includes"| THEMECSS
    CSSDIR -->|"includes"| CLOCKCSS
    CSSDIR -->|"includes"| ANIMCSS
    CSSDIR -->|"includes"| FLEXCSS
    CSSDIR -->|"includes"| POPCSS
    CSSDIR -->|"includes"| ICOMOONCSS

    INDEX -->|"loads_scripts"| JSDIR
    JSDIR -->|"executes"| MAIN
    JSDIR -->|"executes"| CLOCK
    JSDIR -->|"executes"| SIMPLY
    JSDIR -->|"executes"| GMAPJS
    JSDIR -->|"executes"| EASING
    JSDIR -->|"executes"| COUNTTO
    JSDIR -->|"executes"| POPCONF

    %% Runtime dependencies
    MAIN -.->|"uses"| JQ
    MAIN -.->|"uses"| BSJS
    MAIN -.->|"initializes"| MAGLIB
    MAIN -.->|"initializes"| FLEXLIB

    POPCONF -.->|"configures"| MAGLIB

    CLOCK -.->|"uses"| SIMPLY
    CLOCK -.->|"uses_timezone_api"| MOMENT

    GMAPJS -->|"calls"| GMAPAPI

    %% Assets usage
    INDEX -->|"references"| IMGDIR
    INDEX -->|"references"| FONTSDIR
    FONTSDIR -->|"contains"| FBOOT
    FONTSDIR -->|"contains"| FICO
    BOOTCSS -.->|"loads_fonts"| FBOOT
    ICOMOONCSS -.->|"loads_fonts"| FICO
  end

  %% =======================
  %% Diagram 3: Build-Time (Optional Sass Pipeline)
  %% =======================
  subgraph "Build-Time Styling Workflow (Optional)"
    direction TB

    DEV["Developer"]:::person
    SASSDIR["sass/ (Sass sources)"]:::build
    SASSSTYLE["sass/style.scss"]:::build
    SASSBOOT["sass/bootstrap.scss"]:::build
    SASSBOOTDIR["sass/bootstrap/ (partials)"]:::build
    SASSMIX["sass/bootstrap/mixins/"]:::build
    COMP["Sass Compiler (toolchain)"]:::build
    OUTCSS["css/ (Compiled output)"]:::build
    DEPLOY["Commit/Push → GitHub Pages Deploy"]:::infra
    CNAMEF["CNAME (Custom domain config)"]:::infra

    DEV -->|"edits"| SASSDIR
    SASSDIR -->|"contains"| SASSSTYLE
    SASSDIR -->|"contains"| SASSBOOT
    SASSDIR -->|"contains"| SASSBOOTDIR
    SASSBOOTDIR -->|"includes"| SASSMIX

    SASSDIR -->|"compile"| COMP
    COMP -->|"outputs"| OUTCSS
    DEV -->|"publishes"| DEPLOY
    DEPLOY -->|"serves_static_site"| HOST
    DEV -->|"configures_domain"| CNAMEF
    CNAMEF -->|"enables_custom_domain"| DNS
  end

  %% =======================
  %% Cross-links between diagrams
  %% =======================
  HOST -->|"serves"| INDEX
  HOST -->|"serves"| CSSDIR
  HOST -->|"serves"| JSDIR
  HOST -->|"serves"| IMGDIR
  HOST -->|"serves"| FONTSDIR

  %% =======================
  %% Click Events (paths only; not shown in node labels)
  %% =======================
  click INDEX "https://github.com/shyamjos/wedding-website/blob/main/index.html"
  click CNAMEF "https://github.com/shyamjos/wedding-website/tree/main/CNAME"

  click CSSDIR "https://github.com/shyamjos/wedding-website/tree/main/css/"
  click BOOTCSS "https://github.com/shyamjos/wedding-website/blob/main/css/bootstrap.css"
  click THEMECSS "https://github.com/shyamjos/wedding-website/blob/main/css/style.css"
  click CLOCKCSS "https://github.com/shyamjos/wedding-website/blob/main/css/responsive-clock.css"
  click ANIMCSS "https://github.com/shyamjos/wedding-website/blob/main/css/animate.css"
  click FLEXCSS "https://github.com/shyamjos/wedding-website/blob/main/css/flexslider.css"
  click POPCSS "https://github.com/shyamjos/wedding-website/blob/main/css/magnific-popup.css"
  click ICOMOONCSS "https://github.com/shyamjos/wedding-website/blob/main/css/icomoon.css"

  click JSDIR "https://github.com/shyamjos/wedding-website/tree/main/js/"
  click MAIN "https://github.com/shyamjos/wedding-website/blob/main/js/main.js"
  click CLOCK "https://github.com/shyamjos/wedding-website/blob/main/js/clock.js"
  click SIMPLY "https://github.com/shyamjos/wedding-website/blob/main/js/simplyCountdown.js"
  click GMAPJS "https://github.com/shyamjos/wedding-website/blob/main/js/google_map.js"
  click EASING "https://github.com/shyamjos/wedding-website/blob/main/js/jquery.easing.1.3.js"
  click COUNTTO "https://github.com/shyamjos/wedding-website/blob/main/js/jquery.countTo.js"
  click POPCONF "https://github.com/shyamjos/wedding-website/blob/main/js/magnific-popup-options.js"

  click IMGDIR "https://github.com/shyamjos/wedding-website/tree/main/images/"
  click FONTSDIR "https://github.com/shyamjos/wedding-website/tree/main/fonts/"
  click FBOOT "https://github.com/shyamjos/wedding-website/tree/main/fonts/bootstrap/"
  click FICO "https://github.com/shyamjos/wedding-website/tree/main/fonts/icomoon/"

  click SASSDIR "https://github.com/shyamjos/wedding-website/tree/main/sass/"
  click SASSSTYLE "https://github.com/shyamjos/wedding-website/blob/main/sass/style.scss"
  click SASSBOOT "https://github.com/shyamjos/wedding-website/blob/main/sass/bootstrap.scss"
  click SASSBOOTDIR "https://github.com/shyamjos/wedding-website/tree/main/sass/bootstrap/"
  click SASSMIX "https://github.com/shyamjos/wedding-website/tree/main/sass/bootstrap/mixins/"

  %% =======================
  %% Styles
  %% =======================
  classDef person fill:#ffffff,stroke:#6b7280,stroke-width:1px,color:#111827
  classDef client fill:#dbeafe,stroke:#1d4ed8,stroke-width:1px,color:#0b1f44
  classDef frontend fill:#bfdbfe,stroke:#1e40af,stroke-width:1px,color:#0b1f44
  classDef infra fill:#bbf7d0,stroke:#166534,stroke-width:1px,color:#052e16
  classDef external fill:#fed7aa,stroke:#9a3412,stroke-width:1px,color:#431407
  classDef build fill:#e5e7eb,stroke:#374151,stroke-width:1px,color:#111827
  classDef asset fill:#c7d2fe,stroke:#3730a3,stroke-width:1px,color:#111827
```
