{"id":15626266,"url":"https://github.com/grubersjoe/react-github-calendar","last_synced_at":"2025-05-14T16:04:21.143Z","repository":{"id":33153320,"uuid":"152591325","full_name":"grubersjoe/react-github-calendar","owner":"grubersjoe","description":"A React component to display a GitHub contributions calendar","archived":false,"fork":false,"pushed_at":"2025-04-07T19:12:37.000Z","size":16301,"stargazers_count":530,"open_issues_count":2,"forks_count":44,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-12T22:17:13.147Z","etag":null,"topics":["contribution-graph","github","react"],"latest_commit_sha":null,"homepage":"https://grubersjoe.github.io/react-github-calendar","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/grubersjoe.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}},"created_at":"2018-10-11T12:52:21.000Z","updated_at":"2025-04-11T07:39:21.000Z","dependencies_parsed_at":"2023-12-04T22:26:37.451Z","dependency_job_id":"53a61d6d-42d2-4934-a8fc-8d919079a25c","html_url":"https://github.com/grubersjoe/react-github-calendar","commit_stats":{"total_commits":219,"total_committers":5,"mean_commits":43.8,"dds":0.1095890410958904,"last_synced_commit":"0290ccb2ef6902629fc68917813db683c9c2f3df"},"previous_names":["grubersjoe/github-contributions-calendar"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grubersjoe%2Freact-github-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grubersjoe%2Freact-github-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grubersjoe%2Freact-github-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grubersjoe%2Freact-github-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grubersjoe","download_url":"https://codeload.github.com/grubersjoe/react-github-calendar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248637786,"owners_count":21137538,"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","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":["contribution-graph","github","react"],"created_at":"2024-10-03T10:11:48.472Z","updated_at":"2025-04-12T22:17:20.610Z","avatar_url":"https://github.com/grubersjoe.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# React GitHub Calendar\n\n[![CI](https://github.com/grubersjoe/react-github-calendar/actions/workflows/test.yml/badge.svg)](https://github.com/grubersjoe/react-github-calendar/actions/workflows/test.yml)\n[![npm version](https://badge.fury.io/js/react-github-calendar.svg)](https://www.npmjs.com/package/react-github-calendar)\n\nA React component to display a GitHub contributions graph based on\n[`react-activity-calendar`](https://github.com/grubersjoe/react-activity-calendar) and\n[`github-contributions-api`](https://github.com/grubersjoe/github-contributions-api).\n\n![Screenshot](preview.png)\n\n[Demo and documentation](https://grubersjoe.github.io/react-github-calendar/)\n\n## Installation\n\n```shell\nnpm install react-github-calendar\n```\n\n## Usage\n\n```tsx\nimport GitHubCalendar from 'react-github-calendar'\n\n;\u003cGitHubCalendar username=\"grubersjoe\" /\u003e\n```\n\n## FAQ\n\n### Is server side rendering (SSR) supported?\n\nYes. However, not with this component because it fetches data client-side. For SSR support, you can\nfetch the GitHub contribution data from a suitable\n[API](https://github.com/grubersjoe/github-contributions-api) server-side and pass it on to the\ninternally used [`react-activity-calendar`](https://github.com/grubersjoe/react-activity-calendar)\ncomponent. See the\n[source code](https://github.com/grubersjoe/react-github-calendar/blob/main/src/index.tsx) as\nexample and the GitHub color theme.\n\n### Why is Create React App unsupported?\n\nCreate React App (CRA) is considered\n[abandoned](https://github.com/facebook/create-react-app/discussions/11086), and you probably should\nnot use it anymore (more\n[background](https://github.com/facebook/create-react-app/issues/11180#issuecomment-874748552)).\nUsing this component inside CRA will lead to errors for reasons described in issue\n[#105](https://github.com/grubersjoe/react-activity-calendar/issues/105) of\n`react-activity-calendar`. This repo is not for CRA support questions. If you encounter issues, you\nneed to fix those yourself given the maintenance state of CRA. Personally, I would recommend using\n[Vite](https://vitejs.dev/) instead of CRA. It offers everything that CRA does and more.\n\n## Development\n\nStart watch mode for the library first:\n\n```shell\nnpm install\nnpm dev\n```\n\nThen start watch mode of example page:\n\n```shell\ncd example\nnpm install\nnpm dev\n```\n\nOpen http://localhost:3000.\n\n### Publish a new release\n\n```shell\nnpm publish --dry-run\n\n# When you're happy\nnpm publish --access=public\n```\n\n### Update demo page\n\n```shell\nnpm run deploy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrubersjoe%2Freact-github-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrubersjoe%2Freact-github-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrubersjoe%2Freact-github-calendar/lists"}