How mwaseemzakir/learn-dot-net works
Project type and purpose
• This is not a traditional code-centric application but a static resource-curation site: a GitHub repository containing categorized Markdown files (Blogs, Newsletters, Libraries, etc.) to guide .NET developers.
• It serves as a documentation/content site, likely rendered via GitHub Pages or a similar static-site generator (Jekyll by default on GitHub).
File structure
• Top-level directories (Blogs, Books, Courses, Extensions, Libraries, Newsletters, Podcasts, Tools, Websites, Youtubers) each contain a README or markdown files grouping related resources.
• There’s a root README.md that links to all these sections and provides project metadata, badges, and contribution guidelines.
• No source code, build scripts, or container definitions; the “build” consists of rendering markdown into HTML.
README for additional insights
• It describes structure, purpose (curating .NET resources), contribution process, and an external “hits” counter (SeeYouFarm API).
• No mention of custom back end or databases—purely static content with an external badge service.
a. Main components
• Developer (Content Contributor)
• Git Version Control (GitHub Repo)
• Static-Site Generator (SSG, e.g., Jekyll/GitHub Pages)
• CDN / Web Hosting (GitHub Pages, backed by Fastly/CDN)
• External Badge Service (SeeYouFarm)
• End-User Browser
• CI/CD Pipeline (GitHub Actions for preview/builds, if used)
b. Relationships and interactions
• Content Contributor pushes Markdown changes via Git → GitHub Repo
• On push or PR merge, CI/CD (GitHub Actions) triggers a build: SSG converts Markdown → HTML/CSS/JS
• Built site is deployed to GitHub Pages (backed by CDN)
• End-User Browser requests pages from CDN → GitHub Pages → receives HTML
• Browser loads badge from SeeYouFarm API
• PR reviews and merges happen within GitHub (optional Code Owners or reviewers)
c. Architectural patterns/design principles
• “Content as code”: treat documentation resources like software code with version control, pull requests, reviews.
• CI/CD for automated builds and deployment to ensure consistency.
• CDN caching for fast global delivery.
• Micro-services for badges (external API).
d. Key technologies/frameworks/libraries
• Git / GitHub for version control
• Markdown for content
• Jekyll (or GitHub Pages default SSG)
• GitHub Actions (optional)
• GitHub Pages hosting
• CDN layer (Fastly under the hood)
• SeeYouFarm badge API