https://github.com/oxwazz/github_contributions_widget
💡 Showcase your github open-source contributions dynamically!
https://github.com/oxwazz/github_contributions_widget
card dynamically github oss profile showcase stats
Last synced: 3 months ago
JSON representation
💡 Showcase your github open-source contributions dynamically!
- Host: GitHub
- URL: https://github.com/oxwazz/github_contributions_widget
- Owner: oxwazz
- License: mit
- Created: 2024-12-05T08:45:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T04:57:57.000Z (12 months ago)
- Last Synced: 2025-01-20T05:29:26.768Z (12 months ago)
- Topics: card, dynamically, github, oss, profile, showcase, stats
- Language: Rust
- Homepage: https://github-contributions-widget.oxwazz.com/oxwazz
- Size: 1.96 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Contributions Widget
[badge-workflow]: https://img.shields.io/github/actions/workflow/status/oxwazz/github_contributions_widget/release.yml
[link-workflow]: https://github.com/oxwazz/github_contributions_widget/actions/workflows/release.yml
[badge-twitter]: https://img.shields.io/twitter/follow/oxwazz
[link-twitter]: https://x.com/oxwazz
[![badge-workflow]][link-workflow]
[![badge-twitter]][link-twitter]
📷 Show your dynamically generated GitHub contributions to your GitHub profile or your website!
### Contents
- [Usage](#usage)
- [Optional Query Params](#optional-query-params)
- [FAQ](#faq)
- [Why](#why)
- [Limitation](#limitation)
- [Contributing](#contributing)
- [Credit](#credit)
- [License](#license)
## Usage
🎩 Easily showcase your GitHub contributions to your profile! Follow the steps below:
1. Copy the code snippet below and paste it into your `README.md` file.
1. Replace `/oxwazz` with your GitHub username (case-insensitive).
```markdown
```
**Output**
Congratulation! 🎉 You are now showing your GitHub contributions to your profile!
### Optional Query Params
🧪 You can use additional params for customize your needs.
| Description | Query Params | Default Value | Possible Value |
|-----------------------------------|--------------|---------------|--------------------------------|
| filter by PR states | ?states= | - | "MERGED" \| "OPEN" \| "CLOSED" |
| custom widget title | ?title= | - | string |
| custom showing total contribution | ?show-max= | 3 | number (min=1 max=10) |
| custom theme | ?theme= | light | "light" \| "dark" |
and you can combine all the query params. 💪
## FAQ
**1. why is my widget not updating, causing my latest contributions not to be listed?**
> GitHub has image caching by default, this causing your latest contributions not reflect on this widget.
> to solve this issue you can manually update the image using query params like `?refresh-cache=1`
> or you can update `?refresh-cache=` automatically using GitHub Action cronjob
> with [probablykasper/readme-template-action](https://github.com/probablykasper/readme-template-action),
> you can [see the example](https://github.com/oxwazz/oxwazz) in my repository.
**2. can we use a widget theme based on the browser's light or dark mode?**
>
Yes, [GitHub markdown has support for light and dark mode images](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to).
> You can implement a widget that changes its theme depending on the browser's mode using the \ element.
> ```markdown
>
>
>
> 
>
> ```
## Why
🖌️ We create this widget to effortlessly display your GitHub contributions on your profile, highlighting your coding
activity and accomplishments to potential collaborators, employers, or your community. It provides a visually appealing
way to showcase your commitment to open source and personal projects, enhancing your professional presence.
## Limitation
📐 This code is deployed on a [Cloudflare worker](https://developers.cloudflare.com/workers/languages/rust/). As we are
utilizing the free tier, there
are [certain limitations](https://developers.cloudflare.com/workers/platform/limits/#worker-limits)
associated with it. Additionally, it interacts with
the [GitHub API](https://docs.github.com/en/graphql/overview/about-the-graphql-api),
which also
has [usage limits](https://docs.github.com/en/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api#node-limit)
in place.
## Contributing
🎈 Thanks for your help improving the project! We are so happy to have you! We have a
[contributing guide](./CONTRIBUTING.md) to help you get involved in the project.
## Credit
📌 GitHub Contributions Widget is currently being developed and maintained
by [Muhammad Rahmahalim](https://github.com/oxwazz).
This project is inspired by [LeetCode-Stats-Card](https://github.com/JacobLinCool/LeetCode-Stats-Card), but focuses on
showcasing GitHub open-source contributions instead of LeetCode progress. Thank you!
## License
[MIT](./LICENSE) License © 2024 [Muhammad Rahmahalim](https://github.com/oxwazz)