What is this?
Metrics is an infographics generator for GitHub: it turns your account's stats into a card rendered as SVG, Markdown, PDF or JSON that you can embed anywhere, including your profile README.
Metrics is an infographics generator for GitHub: it turns your account's stats into a card rendered as SVG, Markdown, PDF or JSON that you can embed anywhere, including your profile README.Is it a hosted website, or something I run myself?You run it yourself: most people add it as a scheduled GitHub Action in their repository, and there is also a self-hosted web app that ships with a Docker image.
You run it yourself: most people add it as a scheduled GitHub Action in their repository, and there is also a self-hosted web app that ships with a Docker image.What is the easiest way to generate my first card?Clone the repo and run 'npm run quickstart', which walks you through configuration. Alternatively, add the metrics action to a workflow and let GitHub Actions render it on a schedule.
Clone the repo and run 'npm run quickstart', which walks you through configuration. Alternatively, add the metrics action to a workflow and let GitHub Actions render it on a schedule.Does it need a GitHub token to pull my stats?Yes — all data comes from the GitHub API, so a personal access token is required. Plugins for outside services like Steam, WakaTime or Leetcode additionally need their own credentials.
Yes — all data comes from the GitHub API, so a personal access token is required. Plugins for outside services like Steam, WakaTime or Leetcode additionally need their own credentials.Is it only for personal profiles, or can it follow organizations too?All three: it supports user accounts, organization accounts, and even individual repositories.
All three: it supports user accounts, organization accounts, and even individual repositories.What are some of the more unusual things it can track?Beyond code stats: an isometric commit calendar, a 3D GitHub city and Skyline, recently played Steam games, WakaTime coding time, Leetcode stats, Anilist anime and manga lists, Stack Overflow activity, RSS posts, and Google PageSpeed scores with website screenshots.
Beyond code stats: an isometric commit calendar, a 3D GitHub city and Skyline, recently played Steam games, WakaTime coding time, Leetcode stats, Anilist anime and manga lists, Stack Overflow activity, RSS posts, and Google PageSpeed scores with website screenshots.Can I extend it with plugins of my own?Yes — besides the 47 built-in plugins there are community plugins, so the set of trackable stats goes beyond what the core project ships with.
Yes — besides the 47 built-in plugins there are community plugins, so the set of trackable stats goes beyond what the core project ships with.What are similar projects?beautify-github-profile, skill-icons, Badges4-README.md-Profile, github-readme-stats, github-trends, about-me, github-profile-readme-generator, trade-journal
beautify-github-profile, skill-icons, Badges4-README.md-Profile, github-readme-stats, github-trends, about-me, github-profile-readme-generator, trade-journalWhich topics is it in?github-profile, github-api, profile-readme, readme, metrics, analytics, svg, github-actions, github, data-visualization, json, pdf
github-profile, github-api, profile-readme, readme, metrics, analytics, svg, github-actions, github, data-visualization, json, pdf