How oscarpetevi/hello-git-oscarpetevi works
Project type and purpose
• This is not a traditional web app or microservice suite, but an educational content repository (a “Hello Git & GitHub” course) comprised of:
• Markdown lessons and FAQs (hello.md, hello2.md, README.md, notas_segunda_ed.md)
• Code examples in Python (clases/hellogit.py, hellogit2.py)
• Media assets (images for header, book screenshots, GIFs)
• Its primary purpose is to host static teaching materials and sample code, track versions via Git, and publish content (e.g., GitHub Pages or downloadable e‑book).
File structure
• Top‑level:
• README.md – course overview and links
• hello.md / hello2.md – exercise files for students
• notas_segunda_ed.md – update notes for the second edition
• Media/ – images used in the course and book screenshots
• clases/ – simple Python scripts illustrating Git usage within code
• No backend or runtime components; everything is static, versioned text and binary assets.
README for additional insights
• Describes course curriculum, links to Twitch, video lessons, book, and external resources.
• Implies a CI/CD pipeline could exist (e.g., GitHub Actions for e‑book generation or GitHub Pages deployment), although no workflow files are present in the tree.
a. Components
1. Developer Workstation (Local Machine)
– IDE/Editor (e.g., VSCode)
– Terminal with Git, Oh My Zsh, iTerm2
– Local copies of markdown, code, media
2. Git (Local Repository)
– Branches, commits, references (hello.md edits, clases scripts)
3. Remote GitHub Repository
– Origin remote, Pull Requests, Issue tracking (optional)
– GitHub Pages (serving static site)
– GitHub Actions (optional CI for e‑book/pdf generation)
4. Consumers
– Students accessing markdown via GitHub Web UI
– Video viewers on Twitch/YouTube
– Ebook readers (pdf/epub) downloaded from external link
b. Relationships & data flow
– Dev Workstation → (git commit) → Local Git Repo
– Local Git Repo → (git push) → GitHub Remote
– GitHub Remote → (GitHub Pages/Actions) → Public website / e‑book artifacts
– End users (students) pull or clone repo, or browse web content
c. Architectural patterns / design principles
– Content-as-code: Treating course content as versioned source files
– Static site hosting: Optional delivery via GitHub Pages or CDN
– CI/CD for artifacts: Optionally generate PDFs/epubs with GitHub Actions
d. Key technologies & libraries
– Git & GitHub for version control and hosting
– Markdown for content
– Python (minimal) for code examples
– Optionally GitHub Pages, Actions, and external CDNs/e‑book generators
Detail orientation
• Sub‑folders within the GitHub Repo node: /clases, /Media, *.md.
• That media assets flow unchanged through Git to the hosting layer.