diff --git a/README.md b/README.md index 530774be669..8b42e757f11 100644 --- a/README.md +++ b/README.md @@ -1,574 +1,32 @@ -# ๐Ÿ“Š Metrics [](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics) +# ๐Ÿ‘‹ Hi, I'm Jonish -[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml) +๐Ÿš€ Full-stack developer focused on building scalable, production-ready web applications. -Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories! +- ๐Ÿ’ป Frontend: **Next.js, React, Tailwind CSS** +- โš™๏ธ Backend: **Node.js, NestJS** +- ๐Ÿ—„๏ธ Databases: **PostgreSQL, MySQL** +- ๐Ÿ” Auth: **JWT, Role-based access** +- ๐Ÿงฉ Interests: Dashboards, SaaS apps, system design, clean APIs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
For user accountsFor 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! -
+--- +## ๐Ÿ“Š GitHub Metrics -# ๐Ÿ“š Documentation +![Metrics](https://github.com///blob/main/github-metrics.svg) +--- -> *โš ๏ธ 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).* +## ๐Ÿ› ๏ธ Tech Stack +![Next.js](https://img.shields.io/badge/Next.js-black?logo=nextdotjs) +![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black) +![NestJS](https://img.shields.io/badge/NestJS-E0234E?logo=nestjs) +![Node.js](https://img.shields.io/badge/Node.js-339933?logo=nodedotjs) +![PostgreSQL](https://img.shields.io/badge/PostgreSQL-4169E1?logo=postgresql) +![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql) +--- -## ๐Ÿฆฎ 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) - +## ๐Ÿ“ซ Connect with me +- GitHub: https://github.com/