Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lowlighter/metrics

📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!
https://github.com/lowlighter/metrics

automated automation github github-action github-api github-metrics github-profile javascript metrics profile profile-card profile-readme readme readme-generator readme-profile svg-image

Last synced: 3 days ago
JSON representation

📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!

Host: GitHub
URL: https://github.com/lowlighter/metrics
Owner: lowlighter
License: mit
Created: 2020-09-08T16:01:43.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-10-29T12:10:11.000Z (about 1 month ago)
Last Synced: 2024-10-29T14:33:21.649Z (about 1 month ago)
Topics: automated, automation, github, github-action, github-api, github-metrics, github-profile, javascript, metrics, profile, profile-card, profile-readme, readme, readme-generator, readme-profile, svg-image
Language: JavaScript
Homepage: https://metrics.lecoq.io
Size: 169 MB
Stars: 13,674
Watchers: 100
Forks: 1,702
Open Issues: 40
Metadata Files:
- Readme: .github/readme/imgs/about_metrics_are_html.png
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! (JavaScript)
stars - lowlighter/metrics
awesome-ccamel - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! (JavaScript)
awesome-rainmana - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! (JavaScript)
awesome-starts - lowlighter/metrics - 📊 An image generator with 20+ metrics about your GitHub account such as activity, community, repositories, coding habits, website performances, music played, starred topics, etc. that you can put on your profile or elsewhere! (JavaScript)
StarryDivineSky - lowlighter/metrics
stars - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! \[*MIT License*\] (⭐️13876) (JavaScript)
Awesome - metrics - 📊 An infographics generator with 30+ plugins and 200+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! (Communication and Collaboration Tools / Version Control, Wiki, Knowledge base)
awesome-github-profile - metrics
stars - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! \[*MIT License*\] (⭐️13811) (JavaScript)
jimsghstars - lowlighter/metrics - 📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON! (JavaScript)

README

        # 📊 Metrics [](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics)

[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)

Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!

  

    For user accounts

    For organization accounts

  

  

    





  

  

    

      
🧩 Customizable with 47 plugins and 335 options!

    

  

  

    📅 Isometric commit calendar

    🈷️ Languages activity

  

  

        

        Full year calendar

        Half year calendar

        

      

        

        Indepth analysis (clone and analyze repositories)

        Recently used (analyze recent activity events)

        Default algorithm

        Default algorithm (with details)

        

      

  

  

    ✨ Stargazers

    👨‍💻 Lines of code changed

  

  

        

        Classic charts

        Graph charts

        Worldmap

        

      

        

        Repositories and diff history

        Compact display in base plugin

        

      

  

  

    📌 Starred topics

    🌟 Recently starred repositories

  

  

        

        With icons

        With labels

        

      

        

        

        

      

  

  

    📜 Repository licenses

    💡 Coding habits and activity

  

  

        

        Permissions, limitations and conditions

        Licenses overview

        

      

        

        Recent activity charts

        Mildly interesting facts

        

      

  

  

    🏅 Repository contributors

    🎟️ Follow-up of issues and pull requests

  

  

        

        By contribution types

        By number of contributions

        

      

        

        Indepth analysis

        Created on a user's repositories

        Created by a user

        

      

  

  

    🎭 Comment reactions

    🧑‍🤝‍🧑 People

  

  

        

        

        

      

        

        Related to a user

        Related to a repository

        

      

  

  

    💝 GitHub Sponsorships

    💕 GitHub Sponsors

  

  

        

        

        

      

        

        GitHub sponsors card

        GitHub sponsors full introduction

        

      

  

  

    📓 Featured repositories

    💬 Discussions

  

  

        

        Featured

        Pinned

        

      

        

        

        

      

  

  

    💫 Star lists

    📆 Commit calendar

  

  

        

        Repositories from star lists

        Languages from star lists

        

      

        

        Current year

        Full history

        

      

  

  

    🏆 Achievements

    🎩 Notable contributions

  

  

        

        Compact display

        Detailed display

        

      

        

        Indepth analysis

        Contributions in organizations only

        

      

  

  

    📰 Recent activity

    🧮 Repositories traffic

  

  

        

        

        

      

        

        

        

      

  

  

    ♐ Random code snippet

    🎫 Gists

  

  

        

        

        

      

        

        

        

      

  

  

    🗂️ GitHub projects

    🙋 Introduction

  

  

        

        

        

      

        

        For a user or an organization

        For a repository

        

      

  

  

    🌇 GitHub Skyline

    ⏱️ Google PageSpeed

  

  

        

        GitHub Skyline

        GitHub City

        

      

        

        PageSpeed scores

        PageSpeed scores with detailed report

        PageSpeed scores with a website screenshot

        

      

  

  

    🗨️ Stack Overflow

    🌸 Anilist watch list and reading list

  

  

        

        

        

      

        

        For anime watchers

        For manga readers

        For waifus simp

        

      

  

  

    🎼 Music activity and suggestions

    ✒️ Recent posts

  

  

        

        Random tracks from a playlist

        Recently listened

        

      

        

        Latest posts width description and cover image

        Latest posts

        

      

  

  

    🗼 Rss feed

    ⏰ WakaTime

  

  

        

        

        

      

        

        

        

      

  

  

    🗳️ Leetcode

    🕹️ Steam

  

  

        

        

        

      

        

        Recently played games

        Profile and detailed game history

        

      

  

  

    

      🎲 See also community plugins

    

  

  

    🧠 16personalities
^{by @lowlighter}

      Render example

        

        

      

    

    ♟️ Chess
^{by @lowlighter}

      Render example

        

        

      

    

  

  

    🪙 Crypto
^{by @dajneem23}

      Render example

        

        

      

    

    🥠 Fortune
^{by @lowlighter}

      Render example

        

        

      

    

  

  

    💉 Nightscout
^{by @legoandmars}

      Render example

        

        

      

    

    💩 PoopMap plugin
^{by @matievisthekat}

      Render example

        

        

      

    

  

  

    📸 Website screenshot
^{by @lowlighter}

      Render example

        

        

      

    

    🦑 Splatoon
^{by @lowlighter}

      Render example

        

        

      

    

  

  

    💹 Stock prices
^{by @lowlighter}

      Render example

        

        

      

    

    

    

  

  

    

      🖼️ And even more with 4+ templates!

    

  

  

    📗 Classic template

    📘 Repository template

  

  

        

        

        

      

        

        

        

      

  

  

    📙 Terminal template

    📒 Markdown template

  

  

        

        

        

      

        

        

        

      

  

  

    📕 See also community templates

  

  

    🦑 Try it now!

  

  

    📊 Metrics embed

    ✨ Metrics insights

  

  

    

      Embed metrics images on your profile or blog!


      Use GitHub actions for even more features!


      

    

    

      Share your metrics with friends and on social medias!


      No configuration needed!


      

    

  

  

    

      Test latest features and patches on 🧪 Metrics beta!

    

  

  

    

      Power user?


      Fork this repository and edit HTML, CSS, JS and EJS for even more customization!

    

  

# 📚 Documentation

> ^{*⚠️ This is the documentation of **v3.35-beta** (`@master`/`@main` branches) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master) planned for next release. See documentation for current released version [**v3.34** (`@latest` branch) here](https://github.com/lowlighter/metrics/blob/latest/README.md).*}

## 🦮 Setup

There are several ways to setup metrics, each having its advantages and disadvantages:

* [⚙️ Using GitHub Action on a profile repository *(~10 min)*](/.github/readme/partials/documentation/setup/action.md)

  * ✔️ All features

  * ✔️ High availability (no downtimes)

  * ➖ Configuration can be a bit time-consuming

* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)

  * ✔️ Easily configurable and previewable

  * ➖ Limited features *(compute-intensive features are disabled)*

* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)

  * ✔️ Create another shared instance

  * ➖ Requires some sysadmin knowledge

* [🐳 Using command line with docker *(~2 min)*](/.github/readme/partials/documentation/setup/docker.md)

  * ✔️ Suited for one-time rendering

* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)

Additional resources for setup:

* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md)

* [🏠 Run metrics on self-hosted runners](/.github/readme/partials/documentation/selfhosted.md)

* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md)

## 🖼️ Templates

Templates lets you change general appearance of rendered metrics.

* [📗 Classic template _`classic`](/source/templates/classic/README.md)

* [📘 Repository template _`repository`](/source/templates/repository/README.md)

* [📙 Terminal template _`terminal`](/source/templates/terminal/README.md)

* [📒 Markdown template _`markdown`](/source/templates/markdown/README.md)

* [📕 Community templates _`community`](/source/templates/community/README.md)

## 🧩 Plugins

Plugins provide additional content and lets you customize rendered metrics.

**📦 Maintained by core team**

* **Core plugins**

  * [🗃️ Base content _`base`](/source/plugins/base/README.md)

  * [🧱 Core _`core`](/source/plugins/core/README.md)

* **GitHub plugins**

  * [🏆 Achievements _{`achievements`}](/source/plugins/achievements/README.md)

  * [📰 Recent activity _`activity`](/source/plugins/activity/README.md)

  * [📆 Commit calendar _`calendar`](/source/plugins/calendar/README.md)

  * [♐ Random code snippet _`code`](/source/plugins/code/README.md)

  * [🏅 Repository contributors _{`contributors`}](/source/plugins/contributors/README.md)

  * [💬 Discussions _{`discussions`}](/source/plugins/discussions/README.md)

  * [🎟️ Follow-up of issues and pull requests _`followup`](/source/plugins/followup/README.md)

  * [🎫 Gists _`gists`](/source/plugins/gists/README.md)

  * [💡 Coding habits and activity _`habits`](/source/plugins/habits/README.md)

  * [🙋 Introduction _{`introduction`}](/source/plugins/introduction/README.md)

  * [📅 Isometric commit calendar _{`isocalendar`}](/source/plugins/isocalendar/README.md)

  * [🈷️ Languages activity _`languages`](/source/plugins/languages/README.md)

  * [📜 Repository licenses _`licenses`](/source/plugins/licenses/README.md)

  * [👨‍💻 Lines of code changed _`lines`](/source/plugins/lines/README.md)

  * [🎩 Notable contributions _`notable`](/source/plugins/notable/README.md)

  * [🧑‍🤝‍🧑 People _`people`](/source/plugins/people/README.md)

  * [🗂️ GitHub projects _`projects`](/source/plugins/projects/README.md)

  * [🎭 Comment reactions _`reactions`](/source/plugins/reactions/README.md)

  * [📓 Featured repositories _{`repositories`}](/source/plugins/repositories/README.md)

  * [🌇 GitHub Skyline _`skyline`](/source/plugins/skyline/README.md)

  * [💕 GitHub Sponsors _`sponsors`](/source/plugins/sponsors/README.md)

  * [💝 GitHub Sponsorships _{`sponsorships`}](/source/plugins/sponsorships/README.md)

  * [✨ Stargazers _`stargazers`](/source/plugins/stargazers/README.md)

  * [💫 Star lists _`starlists`](/source/plugins/starlists/README.md)

  * [🌟 Recently starred repositories _`stars`](/source/plugins/stars/README.md)

  * [💭 GitHub Community Support _`support`](/source/plugins/support/README.md) _{`⚠️ deprecated`}

  * [📌 Starred topics _`topics`](/source/plugins/topics/README.md)

  * [🧮 Repositories traffic _`traffic`](/source/plugins/traffic/README.md)

* **Social plugins**

  * [🌸 Anilist watch list and reading list _`anilist`](/source/plugins/anilist/README.md)

  * [🗳️ Leetcode _`leetcode`](/source/plugins/leetcode/README.md)

  * [🎼 Music activity and suggestions _`music`](/source/plugins/music/README.md)

  * [⏱️ Google PageSpeed _`pagespeed`](/source/plugins/pagespeed/README.md)

  * [✒️ Recent posts _`posts`](/source/plugins/posts/README.md)

  * [🗼 Rss feed _`rss`](/source/plugins/rss/README.md)

  * [🗨️ Stack Overflow _{`stackoverflow`}](/source/plugins/stackoverflow/README.md)

  * [🕹️ Steam _`steam`](/source/plugins/steam/README.md)

  * [🐤 Latest tweets _`tweets`](/source/plugins/tweets/README.md) _{`⚠️ deprecated`}

  * [⏰ WakaTime _`wakatime`](/source/plugins/wakatime/README.md)

**🎲 Maintained by community**

* **[Community plugins](/source/plugins/community/README.md)**

  * [🧠 16personalities _{`16personalities`}](/source/plugins/community/16personalities/README.md) by [@lowlighter](https://github.com/lowlighter)

  * [♟️ Chess _`chess`](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter)

  * [🪙 Crypto _`crypto`](/source/plugins/community/crypto/README.md) by [@dajneem23](https://github.com/dajneem23)

  * [🥠 Fortune _`fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter)

  * [💉 Nightscout _`nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)

  * [💩 PoopMap plugin _`poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat)

  * [📸 Website screenshot _`screenshot`](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter)

  * [🦑 Splatoon _`splatoon`](/source/plugins/community/splatoon/README.md) by [@lowlighter](https://github.com/lowlighter)

  * [💹 Stock prices _`stock`](/source/plugins/community/stock/README.md) by [@lowlighter](https://github.com/lowlighter)

## 💪 Contributing

If you are interested in contributing, the following resources may interest you:

* [💪 Contribution guide](/CONTRIBUTING.md)

* [🧬 Architecture](/ARCHITECTURE.md)

* [📜 License](/LICENSE)

* **:octocat: GitHub resources**

  * [📖 GitHub GraphQL API](https://docs.github.com/en/graphql)

  * [📖 GitHub GraphQL Explorer](https://docs.github.com/en/free-pro-team@latest/graphql/overview/explorer)

  * [📖 GitHub Rest API](https://docs.github.com/en/rest)

  * [📖 GitHub Octicons](https://github.com/primer/octicons)

Use [`💬 discussions`](https://github.com/lowlighter/metrics/discussions) for feedback, new features suggestions, bugs reports or to request help for installation.

## 📜 License

```

MIT License

Copyright (c) 2020-present lowlighter

```

![Sponsors](https://github.com/lowlighter/metrics/blob/examples/metrics.sponsors.svg)