GitHub Bento Stats

A React component to display GitHub stats in a bento-style layout.

Image

Installation

Install the package using npm:

npm i github-bento-stats

Usage

'use client';

import { GitHubBento } from 'github-bento-stats';

const Page = () => {
  const gitToken = process.env.NEXT_PUBLIC_GITHUB_TOKEN;
  
  if (!gitToken) {
    console.log("GitHub Token is not found");
    return null;
  }

  return (
    <div>
      <GitHubBento
        username='idityaGE'
        githubToken={gitToken}
        showGraph
      />
    </div>
  );
};

export default Page;

Props

| Prop | Type | Description | |-------------|---------|--------------------------------| | username | string | GitHub username. | | githubToken | string | GitHub personal access token (PAT). | | showGraph | boolean | Show contribution graph (optional). |

Environment Variables

Make sure to set up your GitHub token as an environment variable:

NEXT_PUBLIC_GITHUB_TOKEN=your_github_token