https://github.com/grubersjoe/react-github-calendar

A React component to display a GitHub contributions calendar
https://github.com/grubersjoe/react-github-calendar

contribution-graph github react

Last synced: 2 days ago
JSON representation

A React component to display a GitHub contributions calendar

• Host: GitHub
• URL: https://github.com/grubersjoe/react-github-calendar
• Owner: grubersjoe
• License: mit
• Created: 2018-10-11T12:52:21.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T07:15:43.000Z (25 days ago)
• Last Synced: 2024-09-10T09:32:47.099Z (25 days ago)
• Topics: contribution-graph, github, react
• Language: TypeScript
• Homepage: https://grubersjoe.github.io/react-github-calendar
• Size: 14.4 MB
• Stars: 433
• Watchers: 5
• Forks: 39
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React GitHub Calendar

[![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)

A React component to display a GitHub contributions graph based on

[`react-activity-calendar`](https://github.com/grubersjoe/react-activity-calendar)

and

[`github-contributions-api`](https://github.com/grubersjoe/github-contributions-api).

![Screenshot](preview.png?v3)

[Demo and documentation](https://grubersjoe.github.io/react-github-calendar/)

## Installation

```shell

pnpm install react-github-calendar

```

## Development

Start watch mode for the library first:

```shell

pnpm install

pnpm dev

```

Then start watch mode of example page:

```shell

cd example

pnpm install

pnpm dev

```

Open http://localhost:3000.

## Publish a new release

```shell

npm publish --dry-run

# When you're happy

npm publish --access=public

```

### Update demo page

```shell

pnpm run deploy

```