How ashumishra2104/system-design-101 works
Project Type and Purpose
• This is a content‐centric repository for “System Design 101,” housing Markdown guides and category files.
• It’s not a full‐stack web app or microservice; rather, it’s a static content repo combined with a lightweight build step (the scripts/readme.ts) and a CI workflow for onboarding contributors.
Main Components
a. Content Directory (“data/…”)
• All the Markdown source files, organized under data/categories/ and data/guides/.
b. Build Script (scripts/readme.ts)
• A TypeScript utility that reads the data/ folder structure and regenerates the top‐level README.md.
c. Package Configuration (package.json + pnpm-lock.yaml)
• Defines dependencies (e.g., typescript, ts-node) to run the script.
d. Version Control & CI (.github/workflows/welcome.yml)
• A GitHub Actions workflow for contributor onboarding messages.
• (Potentially other CI steps could be added for linting or publishing.)
e. External Hosting / Consumption
• The static content is consumed via links on the ByteByteGo blog site (and syndicated to YouTube and newsletter).
Relationships & Data Flow
1) Developer edits / adds Markdown files under data/.
2) Developer commits & pushes to GitHub.
3) (Optional) A CI workflow runs:
• Executes pnpm install && ts-node scripts/readme.ts to regenerate README.md.
• Validates link formats or folder structure (could be added).
4) Updated README.md is committed back or automatically merged.
5) The static site generator (external to this repo) picks up these Markdown files to publish on the blog.
6) End users browse the ByteByteGo website, following links to each guide.
Architectural Patterns & Principles
• Single Responsibility:
• data/ holds pure content.
• scripts/readme.ts holds content‐to‐README logic.
• CI as “Quality Gate”: ensures consistency of repository state.
• Separation of Concerns: content, build logic, and hosting are decoupled.
Additional Recommendations
• Keep it clean: group all on‐repo artifacts on the left, CI in the center, and external consumption on the right.