How hlxsites/takeda-ihs works
Project Type and Purpose
• This is a Helix-based, component-driven static site built with the Adobe Franklin (Helix) boilerplate.
• It assembles reusable CSS/JS “blocks,” runs via the Helix Proxy in development, and is deployed as static assets behind a CDN in production.
File Structure
• Top-level directories:
• blocks/ – each subfolder is a self-contained UI component (CSS + JS)
• scripts/ – site-wide JavaScript utilities and Partytown integration
• styles/ – global CSS (resets, lazy loading, images)
• well-known/, head.html, fstab.yaml, helix-query.yaml – Helix/Franklin config
• Config files: package.json (dependencies & scripts), .github/workflows/run-tests.yaml (CI), renovation, linting, and ESLint/Stylelint configs.
Extract Key Architecture Insights from README
• Local workflow: developer runs “hlx up” → Franklin Proxy serves dynamic templates from the codebase + remote content
• CI/CD: GitHub Actions (run-tests.yaml) + helix-bot integrate to build & deploy to “preview” and “live” environments via Helix.
Main Components & Interactions
a. Developer Environment
• IDE & GitHub repo → commit → GitHub Actions & helix-bot
• Franklin Proxy (hlx-cli) → local dev URL (http://localhost:3000)
b. Build & Deployment Pipeline
• GitHub Actions workflow → lint & test → invoke Helix Build API → publish to Preview & Live
c. Content & Configuration
• helix-query.yaml → GraphQL or remote CMS queries for page content
• fstab.yaml → mount points mapping Git paths to URL paths
d. Static Assets & Runtime
• blocks/ → individual JS/CSS bundles
• scripts/partytown → isolates third-party scripts into Web Worker
• styles/ → global styling
e. Delivery
• Helix CDN (Fastly) caching layer → “preview” and “live” domains
• End-user browsers retrieving pre-rendered HTML, CSS, JS
Architectural Patterns & Principles
• Componentization: each “block” is an isolated UI module
• Static-site generation with dynamic content fetch at build time
• CI/CD as code: GitHub Actions + Helix Build API
• Edge caching via Fastly CDN for ultra-low latency