How calispec-balaji/github_actions works
Project type + purpose (what you’re diagramming)
This repo is a frontend-only Single Page Application (SPA) template: React + TypeScript + Vite. There is no backend/service layer in the tree; the “system” is primarily:
• a browser runtime (React app)
• a build/dev toolchain (Vite, TypeScript, ESLint)
• static asset serving (Vite dev server in dev; static hosting in prod)
• containerization + CI performance checks (Dockerfile, GitHub Actions workflow, Lighthouse config)
Runtime (what runs in the browser)
• index.html — Vite entry HTML; bootstraps the SPA
• src/main.tsx — React entrypoint; mounts the app to the DOM
• src/App.tsx — root component
• src/assets/* — bundled assets (imported in code)
• public/* — static assets copied as-is (not bundled)
• src/*.css — styling pipeline (bundled via Vite)
Build/dev toolchain (what produces the runtime)
• vite.config.ts — bundler/dev server configuration (plugins, base path, etc.)
• tsconfig*.json — split TS configs for app vs node tooling
• eslint.config.js — linting rules (quality gate)
• package.json / package-lock.json — dependency graph and scripts
Delivery / automation (how it ships / is validated)
• .github/workflows/performance.yml + lighthouserc.cjs + PERFORMANCE_CI.md — CI job that runs Lighthouse (performance/quality regression gate)
What to include as “main components”
Break the system into as many components as is reasonable, even if they’re simple:
User Browser
2. Static Hosting Origin (choose the intended target generically: “CDN / Static host / Nginx container”)
React App
• main.tsx (bootstrapping)
• App.tsx (root UI)
Static Assets
• /public (copied as-is)
• /src/assets (bundled)
• Browser → Static Host: GET /index.html, GET /assets/*.js, GET /assets/*.css, images/fonts
• index.html → loads bundled JS/CSS
• Bundled JS → mounts React into DOM (main.tsx)
Vite Dev Server
• HMR / Fast Refresh
Browser (local)
• Developer edits src/* → Vite transforms → Browser receives HMR updates
• Vite reads index.html as the entry boundary
Vite Build
2. TypeScript compile/typecheck (even if Vite transpiles, TS config still defines types and build constraints)
Static Server / Container Image (if Docker is used for serving)
Relationships
• src/* + index.html + configs → Vite → dist/
• dist/ → deployed to hosting or copied into container
Reports / thresholds (fail/pass gate)
Relationships
• GitHub Actions → install deps → build → run Lighthouse → upload/store results / enforce budgets
Important patterns/design principles to reflect
• SPA + static deployment: no server-side rendering or backend in repo.
• Entry-point driven UI: index.html → main.tsx → App.tsx → component tree.
• Bundled vs unbundled assets:
• public/ = served as-is
• src/assets/ = fingerprinted/bundled
• Separation of concerns:
• runtime UI code in src/
• tooling/config at repo root
• CI in .github/workflows/