How klsoundarya/tales-from-south-india works
Main components
a. Developer Workstation
• IDE (VS Code / Gitpod)
• Local Git repo
• .devcontainer (Dockerfile + docker-compose) for local preview (http_server.py)
b. GitHub
• Remote code repository (push/pull)
• GitHub Pages (static site hosting)
c. CDN / Browser Client
• End-user browsers on various devices
• Fetches HTML, CSS, JS, images, video
Relationships and data flows
• Developer writes code locally → commits & pushes to GitHub
• GitHub Pages automatically serves built static files
• Browser issues HTTP(S) GET requests → receives static assets (HTML, CSS, images, video)
• Responsive design assets adapt rendering for mobile/tablet/desktop
Architectural patterns
• Static Site Architecture (no server-side logic)
• Responsive Design (CSS media-queries)
• DRY asset organization (single CSS file, centralized assets folder)
• Containerized Local Dev Environment (uses Docker to simulate HTTP server)
Relevant technologies
• HTML5, CSS3, media queries, favicon, webfont (Google Fonts, Font Awesome)
• Static deployment via GitHub Pages
• Devcontainer definitions (.devcontainer/Dockerfile, docker-compose.yml)
• Python HTTP server script (for local preview)
Essential details to capture
• Separation of Dev vs. Deployment vs. Runtime environments
• No backend server: all pages are static
• Responsive breakpoints (375px, 425px, 768px, 992px, 1200px)
• Assets live under a single folder, served via GitHub Pages
Final checklist
• Components: Developer IDE/Container, GitHub Repo, GitHub Pages, Client Browsers
• Data Flows: Commit → Push → Deploy → Request → Response