{"id":31692539,"url":"https://github.com/man0dya/readme-contribution-graph-generator","last_synced_at":"2025-10-08T14:54:00.715Z","repository":{"id":317013602,"uuid":"1061826374","full_name":"Man0dya/Readme-Contribution-Graph-Generator","owner":"Man0dya","description":"Transform your GitHub contribution graph into an epic animated display! Watch as your contributions pop and explode with spectacular effects, creating a dynamic visualization perfect for your README.","archived":false,"fork":false,"pushed_at":"2025-09-28T07:58:32.000Z","size":5593,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-28T09:21:26.159Z","etag":null,"topics":["animation","github-actions","github-readme","opensource","react","svg","tailwindcss","vite"],"latest_commit_sha":null,"homepage":"https://man0dya.github.io/Readme-Contribution-Graph-Generator/","language":"JavaScript","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/Man0dya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-22T12:43:26.000Z","updated_at":"2025-09-28T08:16:32.000Z","dependencies_parsed_at":"2025-09-28T09:31:57.006Z","dependency_job_id":null,"html_url":"https://github.com/Man0dya/Readme-Contribution-Graph-Generator","commit_stats":null,"previous_names":["man0dya/readme-contribution-graph-generator"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Man0dya/Readme-Contribution-Graph-Generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Man0dya%2FReadme-Contribution-Graph-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Man0dya%2FReadme-Contribution-Graph-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Man0dya%2FReadme-Contribution-Graph-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Man0dya%2FReadme-Contribution-Graph-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Man0dya","download_url":"https://codeload.github.com/Man0dya/Readme-Contribution-Graph-Generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Man0dya%2FReadme-Contribution-Graph-Generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278963840,"owners_count":26076543,"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-10-08T02:00:06.501Z","response_time":56,"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":["animation","github-actions","github-readme","opensource","react","svg","tailwindcss","vite"],"created_at":"2025-10-08T14:53:42.440Z","updated_at":"2025-10-08T14:54:00.706Z","avatar_url":"https://github.com/Man0dya.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Readme Contribution Graph Generator\n\nTurn your GitHub contribution graph into a playful bubble‑shooter animated SVG you can embed in your README. Generate once or keep it up to date automatically with GitHub Actions.\n\n👉 Live app: https://man0dya.github.io/Readme-Contribution-Graph-Generator\n\n\u003c/div\u003e\n\n---\n\n## For users\n\n### Quick start (no code)\n\n1) Open the live app and enter your GitHub username\n\n2) Customize\n- Theme: Default, GitHub, Ocean, Sunset\n- No‑contribution color and “Hide 0‑days” toggle\n- Animation speed: Slow, Normal, Fast\n\n3) Export\n- Download Animated SVG: for README animations\n- Download Static Graph SVG: plain contribution grid\n- Copy README snippet: auto/light/dark variants supported\n\n4) Add to your README\n- Commit the downloaded SVG to the repo root\n- Paste the generated Markdown snippet in README.md\n\nThat’s it—your animated contribution graph will render on GitHub.\n\n### Automate it in your own repo (daily refresh)\n\nThis project provides:\n- scripts/generate-svg.cjs — a Node script that fetches your real contribution data and writes SVGs\n- A ready‑to‑use GitHub Actions workflow YAML\n\nSteps:\n1) Create scripts/generate-svg.cjs in your repo and copy the script content from this repo or from the app’s “Automate in your own repo” section.\n2) Create .github/workflows/generate-contribution-animation.yml and paste the workflow from the app (or adapt to your needs).\n3) Commit and push. The workflow will:\n   - Run on push, manual dispatch, and nightly (00:00 UTC)\n   - Use the built‑in GITHUB_TOKEN—no PAT required\n   - Commit updated SVGs to your repository root\n4) Add the README snippet, for example:\n\n```markdown\n![My Contribution Animation](github-contribution-animation.svg)\n```\n\nTip: The app can also generate a \u003cpicture\u003e snippet for automatic light/dark mode.\n\n### Troubleshooting\n\n- Image doesn’t appear: ensure the SVG file was committed to the same branch your README is on and the relative path matches.\n- Not updating daily: check the Actions tab for the “Generate Contribution Animation” workflow run; branch protection might block commits from workflows.\n- Private activity: the generator uses public signals; fully private activity is not included.\n\n---\n\n## For developers\n\n### Requirements\n- Node.js 18+ (20 LTS recommended)\n- npm\n\n### Local development\n\n```powershell\n# Install dependencies\nnpm install\n\n# Start dev server (Vite)\nnpm run dev\n# App will open at http://localhost:3000\n\n# Build production bundle\nnpm run build\n\n# Preview the production build locally\nnpm run preview\n```\n\n### Deploying to GitHub Pages\n\nThis repo contains a GitHub Actions workflow at `.github/workflows/deploy.yml` that builds and publishes `dist/` to the `gh-pages` branch on push to `main`.\n\n- Project site URL: `https://\u003cuser\u003e.github.io/Readme-Contribution-Graph-Generator/`\n- Vite base is set to `/Readme-Contribution-Graph-Generator/` in `vite.config.js` so assets resolve under the repo path.\n- If you fork and rename the repository, update `base` accordingly.\n\nOptional manual publish if you prefer pushing from your machine:\n\n```powershell\nnpm run build\nnpm run deploy   # uses gh-pages to publish ./dist to gh-pages\n```\n\n### Project structure\n\n```\nReadme-Contribution-Graph-Generator/\n├─ .github/workflows/\n│  ├─ deploy.yml                         # Pages deployment (builds and publishes dist)\n├─ public/\n│  └─ favicon.svg\n├─ scripts/\n│  └─ generate-svg.cjs                   # CLI generator for automated SVGs\n├─ src/\n│  ├─ App.jsx\n│  ├─ index.css\n│  ├─ main.jsx\n│  ├─ components/\n│  │  ├─ CodeGenerator.jsx               # Customization, downloads, README snippets, workflow/script copy\n│  │  ├─ Footer.jsx\n│  │  ├─ Header.jsx\n│  │  ├─ Hero.jsx\n│  │  └─ UsernameForm.jsx                # Username input + validation\n│  └─ utils/\n│     ├─ debug.js\n│     └─ github.js                       # Fetch/parse contribution data (multiple strategies)\n├─ index.html\n├─ package.json\n├─ tailwind.config.js\n├─ postcss.config.js\n└─ vite.config.js\n```\n\n### How data fetching works (overview)\n\nThe client tries multiple approaches to derive your contribution calendar:\n- Parse GitHub’s public contribution graph HTML via safe CORS proxies\n- Use public activity feeds and repo activity to estimate contributions when needed\nThe resulting 53‑week grid drives both the animated and static SVG outputs.\n\n### Scripts\n\n```powershell\nnpm run dev        # Start development server\nnpm run build      # Build for production (dist/)\nnpm run preview    # Preview dist locally\nnpm run deploy     # Publish dist to gh-pages (optional local path)\nnpm run lint       # Lint\n```\n\n### Notes for forks\n\n- Update `vite.config.js` base to your repository name (e.g., `/my-fork-name/`) so GitHub Pages serves assets correctly.\n- The deployment workflow assumes the default branch is `main`; adjust if yours differs.\n\n---\n\n## Contributing\n\nContributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) and follow the [Code of Conduct](./CODE_OF_CONDUCT.md). Use our [issue templates](./.github/ISSUE_TEMPLATE) and [pull request template](./.github/pull_request_template.md) to streamline reviews.\n\n## Security\n\nPlease report vulnerabilities privately. See [SECURITY.md](./SECURITY.md) for our policy and response timelines.\n\n## License\n\nMIT — see [LICENSE](./LICENSE).\n\n## Acknowledgments\n\n- Inspired by the fun of GitHub profile animations (e.g., snake)\n- Thanks to the React, Vite, Tailwind, and Framer Motion communities\n\n## Support\n\n- Open issues and feature requests on the repository\n- Star the project if it helps your profile shine ✨","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fman0dya%2Freadme-contribution-graph-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fman0dya%2Freadme-contribution-graph-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fman0dya%2Freadme-contribution-graph-generator/lists"}