How reddynextdoor/githubart works
Project type and purpose
• This is a single‐page, client-side web application (“GitArt”) that runs entirely in the browser, served as static assets.
File structure
• Top-level:
• public/ — contains all static front-end assets: index.html, index.js, style.css, logos/examples, robots.txt, sitemap.xml, etc.
• script.sh — helper shell script (likely used for generating or bootstrapping commits locally).
• .github/, .gitignore, CODE_OF_CONDUCT.md, LICENSE, README.md.
• No backend code in this repo: the front end calls out to a remote API (gitart-api).
README for additional insights
• The README describes two workflows:
a. “Generate using GitHub Actions” via calls to https://gitart-api and creating a GitHub Action in a user’s target repo.
b. “Generate git commit commands” to run locally in the user’s terminal and then push to GitHub.
• No mention of any in-repo services, so the front end is purely static.
Main components and interactions
a. Components:
1. Browser / User Interface (public/index.html + public/index.js + style.css)
2. Static Hosting / CDN (e.g., GitHub Pages or any static-site service)
3. GitArt API (external microservice)
4. GitHub Repository & Actions Service
5. User’s Local Git Client / Terminal (for local‐commit workflow)
6. GitHub Server (for remote pushes and Actions run)
b. Relationships & data flow:
• User opens the UI in the browser (fetching static assets from the CDN).
• User paints the calendar grid in the UI.
• On “Generate,” UI sends an HTTPS request to the GitArt API.
• In Actions mode: API returns a GitHub Actions workflow file (YAML) and instructs the GitHub server to create a PR or push directly to the target repo.
• In Local mode: API returns a shell script or a series of git commit --date=... commands.
• Local mode: User copies commands → runs in their terminal → commits locally → git push to GitHub.
• Actions mode: GitHub server picks up the workflow → spins up a runner → executes the generated commits → updates the contribution graph.
Important architectural patterns & design principles
• Static Front-end + API-Driven: clear separation of concerns; front end is decoupled from business logic, which lives in an external microservice.
• Two execution modes (CLI vs. serverless CI/CD), demonstrating extensibility.
• Leverages existing platforms (GitHub Pages, GitHub Actions) rather than self-hosting.
Elements
• Front-end (blue)
• External API (green)
• GitHub services (purple)
• Local terminal (orange)