How marayah31/mariyah works
Project type and purpose
• This “project” is essentially a single‐page, static personal profile README (a GitHub profile landing page) built in Markdown.
• Its purpose is to showcase personal info, tech stack badges, GitHub statistics, streaks, and visitor counts via third‐party badge and stats services.
File structure
• Top level:
• README.md – the only content source.
• No dedicated “src,” “frontend,” or “backend” folders.
• No build scripts or configuration files – GitHub renders the Markdown directly.
README for additional insights
• Uses external image/badge endpoints:
• shields.io (tech stack badges)
• github-readme-stats.vercel.app (profile stats & top langs)
• nirzak-streak-stats.vercel.app (streak counter)
• visitcount.itsvg.in (visit counter)
• All dynamic content is delivered as images embedded in the Markdown.
Main components
a. Markdown content (README.md)
b. GitHub’s markdown renderer / GitHub Pages hosting
c. Client browser
d. External badge & stats services
– shields.io
– GitHub‐readme‐stats (Vercel)
– streak stats service
– visitor count API
Relationships and interactions
• At commit/build time: README.md is stored in GitHub repo.
• At page load:
1) Browser requests the rendered HTML from GitHub.
2) The browser parses HTML and issues HTTP GETs for each badge/stat image from external services.
3) External services return PNG/SVG images.
4) Browser displays them inline.
Architectural patterns / design principles
• Static site (no server‐side code you control)
• Client‐driven data loading (via image tags)
• CDN‐backed third‐party APIs for dynamic stats
Final checklist
• Clear labels on each node (README.md, GitHub Pages, Browser, External API).
• “Repo/host” components
• “Client”
• “Third‐party services”
• Optional: annotate with protocols (HTTPS) and file formats (SVG/PNG).