How rittik9/my-website works
Project type and purpose (from README + tree)
This repo is a personal website deployed to GitHub Pages. Architecturally it’s best modeled as a static-site system with:
• a build-time “backend” (Python scripts that assemble content and generate static artifacts), and
• a run-time “frontend” (HTML/CSS served as static files to browsers; no server-side runtime).
Key indicators:
• .github/workflows/deploy-pages.yml ⇒ CI/CD publishing to GitHub Pages.
• backend/build_static.py, backend/content.py ⇒ static generation pipeline / content processing.
• frontend/templates/*.html + frontend/static/css/style.css ⇒ templated HTML + static assets.
How to read the file structure as architecture
Top-level components implied by the tree:
Build/Generation layer (build-time “backend”)
• backend/build_static.py
Likely the entrypoint that produces the final static site output (renders templates, copies assets, etc.).
• backend/content.py
Likely defines content structures, loads/normalizes content, or provides data passed into templates.
• backend/assets/
Assets used during build (images, files, etc.) or copied into output.
Deployment pipeline
• .github/workflows/deploy-pages.yml
GitHub Actions workflow that builds and publishes site artifacts to GitHub Pages.
• requirements.txt
Python dependencies needed to run the build scripts in CI and locally.
Build/Delivery Architecture (most important here)
• Inputs (templates, content/assets, python code)
• Build process (static generation)
• Artifact output (static HTML/CSS/assets)
• CI/CD publishing (GitHub Actions → GitHub Pages)
Runtime Serving Architecture
• Browser requests pages
• GitHub Pages serves static files
• No application server / database (unless content.py pulls from something external—which is not shown in the tree)
Browser → fetches linked → CSS/assets from GitHub Pages
• render-time dependencies (templates/content/python) vs
• runtime dependencies (browser + static host).
Architectural patterns / principles to call out
• Static Site Generation (SSG) pattern:
• Build step converts templates + content into static HTML.
• Runtime has no dynamic backend.
• Separation of concerns:
• backend/ = generation logic + content modeling
• frontend/ = presentation templates + static styling
• CI/CD to static hosting:
• GitHub Actions is the “deployment orchestrator”
• GitHub Pages is the runtime environment
Break the repo into as many components as practical (without guessing)
• backend/build_static.py
• backend/content.py
• frontend/templates/* (note key templates)
• frontend/static/css/style.css
• .github/workflows/deploy-pages.yml
• requirements.txt
• “Python environment (requirements.txt)”
• “Build step: run build_static.py”
• “Artifact: generated static site (HTML/CSS/assets)”
• “GitHub Pages (static hosting/CDN)”
• “Browser (client)”
Examples:
• “renders templates with content”
• “copies static assets”
• “produces site artifact”
• “deploys to Pages”
• “serves HTML/CSS”