How zawlwintun816/portfolio-website works
Project type & purpose (what you’re diagramming)
This repo is a static front-end portfolio website (HTML/CSS/JS) with client-side interactivity and dynamic content fetched at runtime from Cloudflare R2. There is no backend service in this repo—the “dynamic” behavior comes from the browser calling an external storage endpoint (R2) to retrieve data/assets.
• Static hosting (Pages/GitHub Pages/Netlify/Vercel) serving HTML/CSS/JS
• Browser executing JS (jQuery/Bootstrap/AOS)
• Browser fetching JSON/media/data from Cloudflare R2
• Optional CDN/edge (depending on host) delivering assets faster
From the tree:
• index.html
• The single-page entry point and primary UI composition.
• css/
• style.css (custom styling)
• aos.css (AOS library styling)
• js/
• script.js (your core client logic: dynamic fetching, nav highlight, UI behaviors)
• aos.js (AOS animation library runtime)
• assets/
• Images/media used by the portfolio (local static assets)
• webfonts/
• Font Awesome (and related fonts) delivered as static files
• Bootstrap 5 (either local or CDN referenced in index.html)
• jQuery (either local or CDN referenced in index.html)
• Font Awesome (partly local via webfonts/, possibly CSS via CDN/local)
• Cloudflare R2 (external data hosting; likely JSON files, certificates data, project lists, etc.)
Key runtime behaviors to explicitly show:
• “Dynamic data fetching from Cloudflare R2”
• “AOS scroll animations”
• “Active navigation highlighting based on scroll position”
• “Interactive UI built with JavaScript and jQuery”
• “Deploy on any static hosting platform” (so hosting is an interchangeable component)
• Data flow: Browser → R2 (HTTP GET for JSON/assets) → Browser renders sections
• Rendering flow: HTML loads → JS executes → DOM updated (projects/skills/certifications)
• UI behavior flow: Scroll events → AOS triggers + nav highlighting logic
Browser (Client Runtime)
• Sub-labels inside:
• HTML (index.html)
• CSS (css/style.css, css/aos.css)
• JS (js/script.js, js/aos.js)
• Libraries: jQuery, Bootstrap 5, AOS, Font Awesome
Cloudflare R2 (Object Storage)
• Sub-label: “dynamic data (JSON) + possibly images/certificates)”
Third-party CDNs (optional but accurate if used)
• If everything is local, omit this.
User → Browser
• “Navigates to portfolio URL”
Browser → Static Hosting
• “GET /index.html, /css/*, /js/*, /assets/*, /webfonts/*”
Browser → Cloudflare R2
• “GET dynamic content (e.g., JSON for projects/skills/certifications)”
(Optional) Browser → Third-party CDN
• “GET bootstrap.min.css / jquery.min.js / fontawesome css” etc.
Inside Browser (important for correctness even if not “network”)
• script.js → “Fetch data” → “DOM render/update sections”
• “Scroll events” → “AOS animate” and “Active nav highlight”
Architectural patterns / principles to highlight
• Client-side rendering / enhancement: HTML baseline + JS enhances content and interactivity.
• Externalized content: Data decoupled from deployment via R2 (content updates without redeploy if R2 changes).
• Static hosting: immutable build artifact (no server-side compute).
• Progressive separation:
• Presentation: CSS
• Behavior: JS
• Content: R2 data
Relevant technologies to label (don’t bury them)
• Bootstrap 5 (layout/components)
• jQuery (DOM/events)
• AOS (scroll animation)
• “Cloudflare R2 (Object Storage)”
• “CORS-enabled public reads” (if applicable; dynamic fetch requires it)
Labels
• Protocol: HTTPS
• Resource types: HTML/CSS/JS, JSON, images
• Trigger: “Initial load” vs “On scroll” vs “On page ready”
• Make it obvious that:
• Static host serves the app shell
• The app shell (JS) fetches dynamic data from R2