How reddynextdoor/gitart works
Project type and purpose
• This is a single-page, static front-end application (“GitArt”) that runs entirely in the browser (HTML/CSS/JS) and is hosted (e.g., on GitHub Pages).
• Generate a GitHub Actions workflow via the external GitArt API, or
• Generate a shell script of git commit commands (script.sh) to run locally.
File structure
• Top-level files:
• README.md, LICENSE, CODE_OF_CONDUCT.md, script.sh (local CLI flow)
• .github/FUNDING.yml (funding metadata)
• public/ (static site content):
– index.html, index.js, style.css (the SPA)
– assets/ (logo, example images)
– SEO & verification files (robots.txt, sitemap.xml, BingSiteAuth.xml, etc.)
• No backend code here: the dynamic work is done by the external GitArt API (“gitart-api”).
README for additional insights
• Two usage flows: “Generate using GitHub Actions” (calls GitArt API) and “Generate git commit commands” (script.sh).
• Mentions how UI interacts with GitArt API and GitHub Actions via GitHub tokens.
Capturing essential architectural elements
• Explicitly show the two generation flows side by side.
• Callouts for:
• “script.sh” local CLI path
• “public/index.js” SPA path
• External Dependency: gitart-api
• GitHub Actions runner