search

grubersjoe / react-github-calendar

A React component to display a GitHub contributions calendar
https://grubersjoe.github.io/react-github-calendar
MIT License
453 stars 40 forks source link
contribution-graph github react

readme

React GitHub Calendar

CI

A React component to display a GitHub contributions graph based on react-activity-calendar and github-contributions-api.

Screenshot

Demo and documentation

Installation

npm install react-github-calendar

Known issues

This component cannot be rendered on the server (SSR). Please refer to the known issues of react-activity-calendar for more details how to render it on the client only.

Create React App also is not supported. Again see the README.

Development

Start watch mode for the library first:

npm install
npm dev

Then start watch mode of example page:

cd example
npm install
npm dev

Open http://localhost:3000.

Publish a new release

npm publish --dry-run

# When you're happy
npm publish --access=public

Update demo page

npm run deploy