How robertsonandrew/dashboard-icons works
Project type and purpose
• There is no traditional frontend UI, no backend application server, and no database. Consumers simply download static image files, either directly from GitHub or via a CDN (jsDelivr).
File structure
• Top-level directories and files:
• .github/ (GitHub Actions workflow definitions)
• imgBotConfig (image-optimization configuration)
• There are no server-side frameworks, no “src/” or “lib/” code other than CI helpers.
README for additional insights
• The README describes:
• The use of jsDelivr as an external CDN for faster delivery
• Supported dashboards (Dashy, Homer, Heimdall, etc.)
Main components
a. GitHub Repository
– Holds the source SVGs, generated PNGs, documentation, CI scripts, workflow definitions.
b. Continuous Integration / Automation Layer
– GitHub Actions workflows in .github/workflows trigger on push or on schedule.
c. Publishing / CDN Layer
– jsDelivr pulls from the GitHub repo’s master branch to serve static files over a global CDN.
d. Consumers / End-Users
Relationships and interactions
• Developer push → GitHub triggers Actions → runs Python and imgBot → updates png/ and README → commits back
• Once merged, jsDelivr picks up updated files → caches PNG/SVG globally
• User/browser/terminal curl|wget or static HTML <img> references CDN URLs → CDN returns optimized asset
Architectural patterns and design principles
• GitOps / declarative automation: all transforms happen in CI, no manual editorial steps
• Immutable artifacts: each PNG/SVG combo stored in version control and published as is
• CDN-backed static hosting for scale and low latency
Technologies, frameworks, or libraries
• GitHub Actions (CI/CD): workflow (.yml) definitions
• Python (_ci.py): custom script for generating README galleries or metadata
• ImgBot (imgbotconfig): automated image compression
• jsDelivr CDN: public static resource network
• Markdown (README.md): dynamically injected gallery of <img src="png/...">
Capturing essential architectural elements
• Keep it simple: four zones (Repo, Automation, CDN, User)
• Detail all integration points (GitHub Actions, Python script, ImgBot, jsDelivr)
• That there is no database or application server—just static files
• Every component that touches the SVG/PNG lifecycle is present