{"id":30378200,"url":"https://github.com/cyprieng/github-breakout","last_synced_at":"2025-08-30T11:08:06.893Z","repository":{"id":305376315,"uuid":"1020934621","full_name":"cyprieng/github-breakout","owner":"cyprieng","description":"Generate a Breakout game SVG from a GitHub user's contributions graph","archived":false,"fork":false,"pushed_at":"2025-08-29T06:27:23.000Z","size":116,"stargazers_count":564,"open_issues_count":0,"forks_count":54,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-29T10:27:23.986Z","etag":null,"topics":["breakout","breakout-game","fortheloveofcode","github-actions","github-contribution-graph","github-readme-profile","svg","svg-animations"],"latest_commit_sha":null,"homepage":"https://www.cyprien.io/projects/github-breakout/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyprieng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-16T16:05:57.000Z","updated_at":"2025-08-29T09:43:06.000Z","dependencies_parsed_at":"2025-07-19T21:11:29.888Z","dependency_job_id":null,"html_url":"https://github.com/cyprieng/github-breakout","commit_stats":null,"previous_names":["cyprieng/github-breakout"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/cyprieng/github-breakout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyprieng%2Fgithub-breakout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyprieng%2Fgithub-breakout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyprieng%2Fgithub-breakout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyprieng%2Fgithub-breakout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyprieng","download_url":"https://codeload.github.com/cyprieng/github-breakout/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyprieng%2Fgithub-breakout/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272839743,"owners_count":25001870,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["breakout","breakout-game","fortheloveofcode","github-actions","github-contribution-graph","github-readme-profile","svg","svg-animations"],"created_at":"2025-08-20T18:01:41.094Z","updated_at":"2025-08-30T11:08:06.867Z","avatar_url":"https://github.com/cyprieng.png","language":"TypeScript","readme":"# GitHub Breakout\n\nGenerate a Breakout game SVG from a GitHub user's contributions graph\n\nThis project will grab your contribution graph through the GitHub API and generate images for light and dark mode:\n\n\u003cpicture\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: dark)\"\n    srcset=\"example/dark.svg\"\n  /\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: light)\"\n    srcset=\"example/light.svg\"\n  /\u003e\n  \u003cimg alt=\"Breakout Game\" src=\"example/light.svg\" /\u003e\n\u003c/picture\u003e\n\n## Usage\n\n### GitHub Action\n\nYou can use the provided GitHub Action to build the SVGs so you can display them like on my profile ([github.com/cyprieng](https://github.com/cyprieng)).\n\nThis GitHub workflow generates the SVGs every day and commit them to your repository:\n\n```yaml\nname: generate breakout svg\n\non:\n  schedule:\n    - cron: \"0 */24 * * *\"\n  workflow_dispatch:\n\njobs:\n  generate-svg:\n    permissions:\n      contents: write\n    runs-on: ubuntu-latest\n    timeout-minutes: 5\n\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v4\n\n      - name: generate SVG\n        uses: cyprieng/github-breakout@v1.0.0\n        with:\n          github_username: ${{ github.repository_owner }}\n\n      - name: Move generated SVGs to temp\n        run: |\n          mkdir -p /tmp/breakout-images\n          mv output/light.svg /tmp/breakout-images/breakout-light.svg\n          mv output/dark.svg /tmp/breakout-images/breakout-dark.svg\n\n      - name: Configure git\n        run: |\n          git config user.name \"github-actions[bot]\"\n          git config user.email \"github-actions[bot]@users.noreply.github.com\"\n\n      - name: Commit and force-push SVGs to target branch\n        run: |\n          git checkout --orphan github-breakout\n          git rm -rf .\n          mkdir images\n          mv /tmp/breakout-images/* images/\n          git add images\n          git commit -m \"chore: update GitHub breakout SVGs\" || echo \"No changes to commit\"\n          git push --force origin github-breakout\n```\n\nThen retrieve the images URLs from the github-breakout branch, and add them to your README.md:\n\n```html\n\u003cpicture\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: dark)\"\n    srcset=\"{YOUR IMAGE URL}/images/breakout-dark.svg\"\n  /\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: light)\"\n    srcset=\"{YOUR IMAGE URL}/images/breakout-light.svg\"\n  /\u003e\n  \u003cimg alt=\"Breakout Game\" src=\"{YOUR IMAGE URL}/images/breakout-light.svg\" /\u003e\n\u003c/picture\u003e\n```\n\n### CLI\n\nYou need to get a GitHub Token, then you can run the following command:\n\n`node dist/cli.js {username} {github token} {dark mode: true/false}`\n\n### Library\n\nThe package is currently not available on npm, so you can install it with:\n\n`npm i --save git+ssh://git@github.com:cyprieng/github-breakout.git`\n\nAnd then you can use it like this:\n\n```javascript\nimport { generateSVG } from \"github-breakout\";\n\nawait generateSVG(username, token, false);\n```\n\n### Try it\n\nYou can try it here: [www.cyprien.io/projects/github-breakout](https://www.cyprien.io/projects/github-breakout/#try-it)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyprieng%2Fgithub-breakout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyprieng%2Fgithub-breakout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyprieng%2Fgithub-breakout/lists"}