How gemarodri/capstone499 works
Project Type and Purpose
• This repository is not a traditional full-stack application but a static course website/content management system for “COSC 499: Capstone Software Engineering Project.”
• Key artifacts: Markdown files (lectures, assignments, resources, schedule), a Jekyll configuration file (_config.yml), and supporting PDFs. These indicate a static-site generator (Jekyll) serving as the platform.
File Structure Analysis
• Top-level directories each represent a content category:
• Assigments/ – markdown templates & deliverable guidelines
• Resources/ – supplemental readings & how-to guides
• Slides/ – lecture slide decks (PDF)
• Suggestions/ – week-by-week recommended steps
• Supporting files: projects.md, tentativeschedule.md, EvaluationCriteria.md
• _config.yml implies Jekyll is used to transform markdown into HTML.
• README.md provides course overview and links to other md files.
README Insights
• No runtime components (no server-side code, no databases).
• Emphasis on static content, links, and schedule outline.
• No mention of dynamic interactions beyond standard GitHub Pages hosting.
a. Main Components
• Content Repository (Markdown + PDFs)
• Static Site Generator (Jekyll + plugins)
• Build Environment (local dev machine or CI pipeline)
• Hosting Service (GitHub Pages)
• End-user Client (web browser)
b. Relationships & Data Flow
1. Contributor commits markdown/PDF changes to GitHub repo.
2. CI or local Jekyll build reads _config.yml, applies templates, outputs HTML/CSS/JS assets.
3. Build artifacts are pushed to GitHub Pages (gh-pages branch).
4. End users access the live site via browser.
c. Architectural Patterns & Principles
• Static Site Generation: content-first, write once–publish everywhere.
• GitOps: all content and config in Git, version controlled.
• CI/CD pipeline (optional) automates build & deploy.
d. Key Technologies
• Jekyll (Ruby-based SSG)
• Git/GitHub for version control & hosting
• Markdown for content
• GitHub Actions or similar for automated builds (if present)
Detailed Yet Focused
• Plugin or configuration steps (e.g., “_config.yml sets baseurl, theme”).
• Don’t over-componentize: treat each content folder as one block unless a deeper breakdown is needed.