How shyamjos/wedding-website works
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