rick/indiekit-endpoint-github
1
0
Fork 0
mirror of https://github.com/rmdes/indiekit-endpoint-github.git synced 2026-06-24 07:18:56 +00:00
Code Issues Projects Releases Packages Wiki Activity
custom plugin to fetch data from Github for Indiekit
23 commits 1 branch 0 tags 141 KiB
  • JavaScript 84.5%
  • Nunjucks 11.2%
  • CSS 4.3%
Find a file
Exact
Ricardo 90fa683019 feat: own github-repos block + add /api/repos endpoint (Phase 7c) 
Add get blocks() (github-repos, source:api) so the block is plugin-owned
(requiresPlugin stamped). Add a public /api/repos endpoint (GitHubClient +
token + cache, own repos, !fork && !private filtered server-side) so the
widget's Repos tab routes through the plugin instead of hitting api.github.com
directly from the browser — the plugin becomes the single source of truth.
Admin/config pages untouched (additive on routesPublic only).
2026-06-23 23:59:56 +02:00
assets refactor: align views to upstream @indiekit/frontend patterns 2026-02-12 17:41:45 +01:00
includes Initial release of @rmdes/indiekit-endpoint-github v1.0.0 2026-01-19 12:43:46 +01:00
lib feat: own github-repos block + add /api/repos endpoint (Phase 7c) 2026-06-23 23:59:56 +02:00
locales feat: add i18n support for 14 languages 2026-02-13 22:33:11 +01:00
tests feat: own github-repos block + add /api/repos endpoint (Phase 7c) 2026-06-23 23:59:56 +02:00
views refactor: align views to upstream @indiekit/frontend patterns 2026-02-12 17:41:45 +01:00
.gitignore Initial release of @rmdes/indiekit-endpoint-github v1.0.0 2026-01-19 12:43:46 +01:00
CLAUDE.md docs: document startup-gate usage in CLAUDE.md 2026-03-28 23:25:00 +01:00
index.js feat: own github-repos block + add /api/repos endpoint (Phase 7c) 2026-06-23 23:59:56 +02:00
package.json feat: own github-repos block + add /api/repos endpoint (Phase 7c) 2026-06-23 23:59:56 +02:00
README.md Initial release of @rmdes/indiekit-endpoint-github v1.0.0 2026-01-19 12:43:46 +01:00

README.md

@rmdes/indiekit-endpoint-github

A GitHub activity endpoint plugin for Indiekit. Display your GitHub commits, stars, contributions, and featured repositories in your Indiekit admin dashboard, with a public JSON API for use in your static site.

Features

  • Featured Projects: Showcase specific repositories with recent commits
  • Recent Commits: Display your latest commits across repositories
  • Starred Repositories: Show repos you've recently starred
  • PRs & Issues: Track your open source contributions
  • Public API: JSON endpoints for integrating with static site generators

Installation

npm install @rmdes/indiekit-endpoint-github

Configuration

Add the plugin to your Indiekit configuration:

export default {
  plugins: [
    "@rmdes/indiekit-endpoint-github",
    // ... other plugins
  ],

  "@rmdes/indiekit-endpoint-github": {
    // Required: Your GitHub username
    username: "your-username",

    // Optional: GitHub personal access token for higher rate limits
    // and access to private repos (set via GITHUB_TOKEN env var)
    token: process.env.GITHUB_TOKEN,

    // Optional: Mount path for the endpoint (default: "/github")
    mountPath: "/github-api",

    // Optional: Cache duration in milliseconds (default: 15 minutes)
    cacheTtl: 900_000,

    // Optional: Limits for each section
    limits: {
      commits: 10,
      stars: 20,
      contributions: 10,
      repos: 10,
    },

    // Optional: Featured repositories to showcase with commits
    featuredRepos: [
      "owner/repo-name",
      "owner/another-repo",
    ],
  },
};

Endpoints

Protected (require authentication)

  • GET /github-api/ - Dashboard view with all sections
  • GET /github-api/commits - Recent commits page
  • GET /github-api/stars - Starred repositories page
  • GET /github-api/contributions - PRs & Issues page
  • GET /github-api/activity - Activity feed page

Public API (no authentication)

  • GET /github-api/api/commits - JSON: Recent commits
  • GET /github-api/api/stars - JSON: Starred repositories
  • GET /github-api/api/activity - JSON: Activity feed
  • GET /github-api/api/featured - JSON: Featured repositories with commits

Using the Public API

The public API endpoints return JSON and can be used by your static site generator (Eleventy, Hugo, etc.) to display GitHub activity on your public site.

Example Eleventy data file:

import EleventyFetch from "@11ty/eleventy-fetch";

export default async function() {
  const url = "https://your-site.com/github-api/api/featured";

  const data = await EleventyFetch(url, {
    duration: "15m",
    type: "json",
  });

  return data.featured || [];
}

Environment Variables

  • GITHUB_TOKEN - Optional GitHub personal access token for:
    • Higher API rate limits (5000/hour vs 60/hour)
    • Access to private repository information

License

MIT