https://github.com/cnocon/react-github-stats-card

React version of the GitHub stats card component.
https://github.com/cnocon/react-github-stats-card

github-api-v3 github-stats-card github-user-stats npm npm-package react reactjs

Last synced: 6 days ago
JSON representation

React version of the GitHub stats card component.

• Host: GitHub
• URL: https://github.com/cnocon/react-github-stats-card
• Owner: cnocon
• License: mit
• Created: 2020-12-29T18:03:28.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-05T11:50:05.000Z (about 4 years ago)
• Last Synced: 2025-01-14T18:17:07.457Z (10 days ago)
• Topics: github-api-v3, github-stats-card, github-user-stats, npm, npm-package, react, reactjs
• Language: CSS
• Homepage: https://react-github-stats-card-demo.netlify.app/
• Size: 1010 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Stats Card for React

Pass a [GitHub username](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email) and a boolean for whether or not you want the theme to be used, and get this:

![Widget Screenshot](stat-card-preview.png)

## Installation

```bash

npm install react-github-stats-card

```

## Example:

The Card function returns a functional React Component. Imports will be updated in the future to get rid of using `dist`.

```js

import Card from 'react-github-stats-card/dist/Card';

function myComponent() {

  return 

}

```

## Note: If you run into rate limiting errors from GitHub, you can pass your personal access token, demonstrated below, to increase that limit. Be sure to keep any hardcoded access token values out of your code!

```js

import Card from 'react-github-stats-card/dist/Card';

function myComponent() {

  return 

}

```