How abhivaikar/howtheytest works
Project Type and Purpose
• This is a static documentation website (“How They Test”) built on Markdown and rendered client-side via Docsify. It’s hosted via GitHub Pages. Its sole purpose is to serve a curated collection of links and resources about software testing practices worldwide.
File Structure Analysis
• Top-level files:
• index.html – bootstrap for the single-page app
• README.md, _coverpage.md – Markdown content loaded by Docsify
• _config.yml – Docsify configuration
• CODE_OF_CONDUCT.md, LICENSE – repository metadata
• .nojekyll – disables Jekyll on GitHub Pages
• Directories:
• .github/FUNDING.yml – funding metadata for GitHub
• No “backend” or server-side code: all rendering is client-side, with assets served as static files.
README Insights
• Confirms use of Docsify (“Static site powered by docsify”)
• Notes external image sources (undraw.co, contributors-img.web.app)
• No server components, databases, or microservices mentioned.
a. Main Components
• Developer/Content Contributor
• GitHub Repository (source of truth for Markdown and configuration)
• GitHub Pages (static hosting service)
• CDN (for Docsify JS library, external images, contributor avatars)
• Client Browser (executes Docsify, renders site)
• External Asset Services (undraw.co, contributors-img.web.app)
b. Relationships & Data Flow
1. Developer commits Markdown, HTML, config to GitHub repo.
2. GitHub Pages builds (serves static files directly—no build step).
3. Browser requests index.html from GitHub Pages → receives HTML + Docsify loader.
4. Browser loads Docsify script from CDN → initializes single-page app.
5. Docsify fetches Markdown files (README.md, _coverpage.md) and _config.yml from the same origin.
6. Docsify renders HTML on the fly in the browser.
7. Browser retrieves images and contributor avatars from external CDNs (undraw.co, contributors-img.web.app).
c. Architectural Patterns & Principles
• Single-Page Application: entirely client-rendered from Markdown.
• Serverless / JAMstack: static hosting + client-side rendering, no backend code.
• Content-as-Code: all site content lives in version control as Markdown.
• CDN distribution: heavy reliance on CDNs for libraries and assets for global performance.
d. Key Technologies
• Docsify (JavaScript SPA framework for Markdown docs)
• GitHub Pages (static site hosting)
• Markdown (README.md, _coverpage.md)
• HTML/CSS/JavaScript (index.html, styling, loader)
• External CDNs (jsDelivr or unpkg for Docsify, undraw.co, contributors-img.web.app)