Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brunobritodev/awesome-github-stats
🚀 Show everyone how amazing you are! Stay motivated and display your total contributions and level on your GitHub profile README
https://github.com/brunobritodev/awesome-github-stats
List: awesome-github-stats
dotnet5 github github-stars github-stats profile profile-readme readme-card readme-generator statistics-images
Last synced: about 2 months ago
JSON representation
🚀 Show everyone how amazing you are! Stay motivated and display your total contributions and level on your GitHub profile README
- Host: GitHub
- URL: https://github.com/brunobritodev/awesome-github-stats
- Owner: brunobritodev
- License: mit
- Created: 2021-05-09T19:43:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T20:16:03.000Z (9 months ago)
- Last Synced: 2024-05-22T16:11:41.223Z (4 months ago)
- Topics: dotnet5, github, github-stars, github-stats, profile, profile-readme, readme-card, readme-generator, statistics-images
- Language: C#
- Homepage: https://awesome-github-stats.azurewebsites.net/
- Size: 28.2 MB
- Stars: 189
- Watchers: 3
- Forks: 20
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - brunobritodev/awesome-github-stats - 🚀 Show everyone how amazing you are! Stay motivated and display your total contributions and level on your GitHub profile README (C# #)
README
Get an accurate data from your contributions and transform into a card to show at your GitHub profile README
View Demo
# Content
- [Content](#content)
- [🚀 Quick setup](#-quick-setup)
- [💻 Demo Site](#-demo-site)
- [💁🏻 SVGs wanted.](#-svgs-wanted)
- [🖌️ Card Types](#️-card-types)
- [🎨 Themes](#-themes)
- [🔧 Options](#-options)
- [Example](#example)
- [ℹ️ How these stats are calculated](#ℹ️-how-these-stats-are-calculated)
- [🤗 Contributing](#-contributing)
- [🤔 Motivations](#-motivations)
- [🧰 Installing Requirements](#-installing-requirements)
- [Requirements](#requirements)
- [Authorization](#authorization)
- [Running the tests](#running-the-tests)
- [💕 Special thanks](#-special-thanks)
- [🙋♂️ Support](#️-support)
## 🚀 Quick setup
1. Copy-paste the markdown below into your GitHub profile README
2. Replace the value after `brunobritodev` with your GitHub username
```md
[](https://git.io/awesome-stats-card)
```
## 💻 Demo Site
Here you can customize your Card with a live preview:
[](https://awesome-github-stats.azurewebsites.net/)
## 💁🏻 SVGs wanted.
If you are a Jedi Master building SVG, help-me adding new SVG's templates. Then we try to add some data on it!
----
## 🖌️ Card Types
There are few Card types to show your stats. Change `cardType` parameter.
| Card | Preview |
| :---------------: | :----------------------------------------------------------------------------------------------------------------: |
| `level (default)` |  |
| `level-alternate` |  |
| `github` |  |
| `octocat` |  |
## 🎨 Themes
To enable a theme, append `&theme=` followed by the theme name to the end of the source url:
```md
[](https://git.io/awesome-stats-card)
```
| Theme | Preview |
| :----------: | :-----------------------------------------------------------------------------------------------------: |
| `default` |  |
| `dark` |  |
| `tokyonight` |  |
| More themes! | **🎨 [See a list of all available themes](./docs/themes/README.md)** |
> If you have come up with a new theme you'd like to share with others, open an issue to add it!
## 🔧 Options
The `user` field is part of url `user-stats/`, which is required. All other fields are optional.
If the `theme` parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values.
| Parameter | Details | Example |
| :----------: | :--------------------------------------------------: | :---------------------------------------------------: |
| `theme` | The theme to apply (Default: `default`) | `dark`, `radical`, etc. [🎨➜](./docs/themes/README.md) |
| `show_icons` | Dont shown icons at left of labels (Default: `true`) | `true` or `false` |
| `preferLogin`| Use github login instead of name (Default: `false`) | `true` or `false` |
| `background` | Background color | **hex code** (without `#`) or **css color** |
| `border` | Border color | **hex code** (without `#`) or **css color** |
| `text` | Color of the text | **hex code** (without `#`) or **css color** |
| `title` | Color of the title at top | **hex code** (without `#`) or **css color** |
| `icon` | Color of the icons | **hex code** (without `#`) or **css color** |
| `ring` | Color of the ring around the level | **hex code** (without `#`) or **css color** |
### Example
```md
[](https://git.io/awesome-stats-card)
```
## ℹ️ How these stats are calculated
This tool uses GitHub GraphQL to compute yours contributions since your first day at GitHub.
To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page.
Contributions include:
* Public commits
* Private commits
* Commits in your repositories
* Commits made in another repositories
* Pull requests to your repositories
* Pull requests to another repositories
* Issues
* Direct stars - Stars from your repositories
* Indirect Stars - Stars from repo's you have made some contribution
* Repositories you have created
If stats not showing look at [Learn more about what is considered a contribution](https://docs.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile).
> Note: You may need to wait up to 24 hours for new contributions to show up ([Learn how contributions are counted](https://docs.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile))
> Note: To prevent too many requests at GitHub we have an agressive cache strategy. You have to wait 24 hours to our server fetch your data again.
To check your stats go to:
* Stats: https://awesome-github-stats.azurewebsites.net/user-stats/brunhbrito/stats
* Rank: https://awesome-github-stats.azurewebsites.net/user-stats/brunobritodev/rank
The magic🌟 begins from these endpoints!
## 🤗 Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.
Make sure your request is meaningful and you have tested the app locally before submitting a pull request.
## 🤔 Motivations
Actually another repositories with the same goal doesn't count stats with accuracy. The main goal is to have a strong data first, then a beatiful svg.
## 🧰 Installing Requirements
#### Requirements
- [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0)
### Authorization
To get the GitHub API to run locally you will need to provide a token.
1. Go to
2. Click **"Generate new token"**
3. Add a note (ex. **"GitHub Pat"**), then scroll to the bottom and click **"Generate token"**
4. **Copy** the token to your clipboard
5. **Go to** file `appsettings.json` in the `src/AwesomeGithubStats.Api` directory and add your PAT at `PATS: [...]` with **your token**
```json
"PATS": [
"your_pat_here"
]
```
### Running the tests
Before you can run tests, you have to add your PAT in `appsettings.json` at `tests/Tests`. Just how you have done above.
```bash
dotnet test
```
## 💕 Special thanks
Special thanks for [github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats) who build a Demo site. This version is almost the same code from there.
And another special thank to [Sindre Sorhus](https://github.com/sindresorhus) to increase the difficult to find a magical number to create Levels. The levels are based in his contributions.
----
## 🙋♂️ Support
💙 If you like this project, give it a ⭐ and share it with friends!
---
Made .NET 6 ❤️