How juancamacho198/hello-git-ejerciciopractico works
Project type and purpose
• This is not an application with backend/frontend code; it’s a content‐only repository that hosts a Git & GitHub tutorial (Markdown files and media).
• Its primary purpose is to serve as the source for a static documentation/website (e.g., GitHub Pages).
File structure
• Top-level:
• README.md – the home page content
• hello.md – exercise file for students
• notas_segunda_ed.md – notes for second edition
• Media/ – images and book screenshots
• .gitignore, LICENSE – repo metadata
• No source code modules, no server code, no build scripts present in this tree.
README for additional insights
• The README describes the course structure, lessons, external video links (YouTube/Twitch), GitHub Actions tutorial, and links to external services (Discord, m←ur←dev.pro).
• There is mention of GitHub Pages (implicit, via badges and site links) but no local build config.
Main components and interactions
a. Components
• Content Authoring Environment (local machine with Git + Markdown editor)
• Git Repository (GitHub)
• Build/CI (optional GitHub Actions if enabled)
• Hosting Service (GitHub Pages or equivalent static site hosting)
• End‐User Web Browser
• External Services (YouTube, Twitch, Discord, m←ur←dev.pro)
b. Relationships & Data Flow
1. Author writes/edits Markdown & commits via Git CLI → pushes to GitHub remote.
2. GitHub remote stores content; on push, optionally triggers a GitHub Actions workflow that:
– Converts Markdown + Media → Static HTML/CSS/JS
– Deploys artifacts to GitHub Pages branch.
3. Hosting service (GitHub Pages) serves static site to end‐users.
4. End‐User’s browser renders content, with embedded links/videos from external services (YouTube/Twitch).
c. Architectural patterns & principles
• “Content as Code” pattern: using Git for versioning documentation.
• CI/CD for content: automating static build and deployment.
• Static–site pattern: decoupled content storage and delivery via CDN.
d. Relevant technologies/frameworks
• Git (version control)
• GitHub (remote repo, possible GitHub Actions)
• GitHub Pages or another static‐site host
• Markdown → HTML converter (Jekyll, Hugo, or built-in GitHub converter)
Detail without over-splitting
• Every logical step: authoring, versioning, build, deploy, serve, embed external.
• Do not invent micro-services or code modules; focus on the actual content workflow and hosting.
Summary