GitHub - SlickFast/github-dashboard-template: One Click Template + Add slickfast API Key = Live Dashboard Badge On Your Github Readme.

GitHub

3 min read Original article ↗

SlickFast GitHub dashboard — teal showcase board

⬆ This is the teal-hero layout. Set LAYOUT=teal-hero to get this exact board with your repo's live stats. More layouts below ⬇

One click + one SlickFast key = a live dashboard on your GitHub README. Real stats — stars, forks, issues, commits-per-week — in one image that updates itself. Your README doesn't have to be flat badges and blurry stat cards — drop in one URL, get a full dashboard that's vector-sharp at any zoom and updates itself.

This very repo runs the template. The dashboard below is live:

Live dashboard — powered by SlickFast

Get yours — 3 steps, ~2 minutes

  1. Click the green Use this template button (top of this page) → create your repo.
  2. Add one secret: your repo → Settings → Secrets and variables → Actions → New repository secret → Name: SLICKFAST_KEY, Value: your key from slickfast.com (free tier, no card).
  3. Run it once: your repo → Actions tab → pulseRun workflow.

Done. The first run adds the live dashboard to your README automatically and prints its permanent URL. From then on it refreshes itself every 6 hours — no server, no maintenance, no GitHub tokens (the built-in Actions permission reads your repo's public stats).

Pick a layout (optional)

Set a repository variable named LAYOUT (Settings → Secrets and variables → Actions → Variables tab). Every example below is a live chart of facebook/react, rendered by this exact template:

LAYOUT Looks like Best for
teal-hero ⬆ the image above — KPIs, CI gauge, contribution calendar, commits + languages on dark teal the showcase board
strip (default) live example — 3 stats over 3 graphs (commits trend, commits bars, languages) most READMEs
square live example — 4 stats, commits graph below compact
contributors live example — stats + top-contributor bars + commits team projects
graphs live example — commits + languages, all graphs data lovers
ci live example — a single CI-health gauge a live "build passing" badge, upgraded
release live example — a single latest-release tile (version, release date, updated stamp) version badge, upgraded
light live example — the main board on white light-mode READMEs

Every example is refreshed daily with facebook/react's real, current stats — click one tomorrow and the numbers will have moved.

Good to know

  • The image URL is keyless and permanent — safe to embed anywhere; your SlickFast key stays a secret in Actions and never appears in your README.
  • SVG on GitHub — the auto-embedded image is .svg: always crisp at any zoom. A .png twin exists at the same URL (swap the extension) for places that need it (email, Slack).
  • Free-tier friendly — every-6-hours ≈ 120 updates/month, comfortably inside the free 250. Faster refresh? Any paid plan lifts the ceiling; edit the cron in .github/workflows/pulse.yml.
  • Local run (optional): REPO=owner/name SLICKFAST_KEY=... GITHUB_TOKEN=... node update-dashboard.mjs — Node 18+, zero dependencies.

Built with SlickFast — charts for AI agents and humans. Embed once, update forever.