packages/github-data/README.md

@portfolio/github-data

GitHub API integration using Octokit.

Overview

This package provides GitHub data access for the portfolio:

  • Repository metadata
  • Repository language breakdowns

Dependencies

  • @octokit/rest - GitHub REST API client

Usage

import { calculateLanguagePercentages, fetchRepoLanguages, getOctokit } from '@portfolio/github-data';

const token = process.env.GH_TOKEN;
const octokit = await getOctokit({ token });
const repo = await octokit.rest.repos.get({ owner: 'Volpestyle', repo: 'portfolio' });
const languages = await fetchRepoLanguages({ token, owner: 'Volpestyle', repo: repo.data.name });
const percentages = languages ? calculateLanguagePercentages(languages) : [];

Environment Variables

VariableDescription
GH_TOKENGitHub Personal Access Token

Related Packages