Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vansh-codes/gityzer
Generates personalized image summarizing your GitHub stats making your readme standout
https://github.com/vansh-codes/gityzer
badge github-resume gityzer gssoc-ext hacktoberfest hacktoberfest-accepted readme sharing
Last synced: about 1 month ago
JSON representation
Generates personalized image summarizing your GitHub stats making your readme standout
- Host: GitHub
- URL: https://github.com/vansh-codes/gityzer
- Owner: vansh-codes
- License: mit
- Created: 2024-09-23T17:38:50.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-04T07:48:29.000Z (about 2 months ago)
- Last Synced: 2024-11-04T08:30:02.128Z (about 2 months ago)
- Topics: badge, github-resume, gityzer, gssoc-ext, hacktoberfest, hacktoberfest-accepted, readme, sharing
- Language: JavaScript
- Homepage: https://gityzer.vercel.app
- Size: 836 KB
- Stars: 7
- Watchers: 1
- Forks: 22
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# **GITYZER**
Gityzer is an open-source tool that generates a personalized image summarizing a user's GitHub stats. This image can be easily embedded in GitHub README files, helping developers showcase their contributions, coding activity, and overall GitHub presence.*
🤖 Project
🌟 Stars
🍴 Forks
🐛 Issues
🔔 Open PRs
🔕 Close PRs
👥 Contributors
## 
Live Demo
Visit https://gityzer.vercel.app/ to see the live demo
> [!NOTE]
> Take UI inspiration from [Socialify](https://socialify.git.ci/)
> Inspiration doesnt means copying the exact same UI from there
## 💪 Outreach
Gityzer is proudly part of global initiatives engaging with passionate developers and open-source enthusiasts worldwide:
Name
Logo
Purpose
GSSoC'2024-Extd
The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform.
Hacktoberfest 2024
Hacktoberfest is a month-long October event welcoming all skill levels to join the open source community
## Technologies Used:
### How it works
1. **Fetch GitHub Data:** Gityzer collects details about a user's GitHub profile, such as:
- Total contributions
- Participation in repositories
- Active coding days
- Most used programming languages
- And many more parameters
2. **Generate a Custom Tagline:** Using AI (the Gemini model), Gityzer creates a unique tagline for each user based on their activity and contribution patterns on GitHub. This tagline is consistent and meaningful, providing an at-a-glance summary of the user's work.
3. **Create and Embed an Image:** The tool generates an image with the following customizable elements:
- **Username:** Details fetched from the GitHub profile.
- **Styling Options:** Users can choose from different styles, themes (like dark or light mode), and color combinations.
- **Update Frequency:** Users can decide how often the image gets updated (e.g., every 14 days).
4. **Avoid Rate Limits:** To prevent hitting GitHub’s API rate limits, users will need to provide their *GitHub personal access token* with read permissions. This allows them to fetch their own profile data more efficiently.
**Example URL:**
Users can generate and customize the image using a URL like:
```css
gityzer.vercel.app?&update=14&style=dark&theme=dark&color=white
```
- ``: The GitHub username.
- `update=14`: Update the image every 14 days (optional parameter, default is 14).
- `style=dark`: Choose the style (e.g., dark).
- `theme=dark`: Set the theme (e.g., dark mode).
- `color=white`: Choose the text color (e.g., white).
## ✨ Project Structure
Check the project structure here [Project Structure](PROJECT_STRUCTURE.md)
## How to contribute ?
Contributors can help by:
- **Building the API:** Integrating GitHub’s API to fetch user data.
- **Fine-tuning the Gemini AI model:** Ensuring the AI generates meaningful taglines.
- **Improving the Image Generator:** Enhancing the styling options and themes.
- **Improving the Website UI:** Enhancing the website style, design and UI
- **Improving User Experience:** Simplifying the setup process for users and ensuring smooth token handling to avoid rate limits.
> [!TIP]
> Gityzer aims to make it easy for developers to create dynamic, personalized badges for their GitHub profiles, helping them stand out with a summary of their contributions in a visually appealing way. Let's work together to build this awesome tool!
Want to Contribute?
We welcome contributors from the Developers & AI community to enrich Gityzer and make it even more valuable for everyone. Please follow our [CONTRIBUTING guidelines](https://github.com/vansh-codes/Gityzer/blob/master/CONTRIBUTING) for the following:-
***Want to contribute to our website you must have to read [CONTRIBUTING guidelines](https://github.com/vansh-codes/Gityzer/blob/master/CONTRIBUTING).***
- Setup Gityzer on your local machine
- Enhance the website
- Finetune the AI model
- enhance the image generation by making it responsive, adding themes and colors
- And more!
Project Admin
## Code Of Conduct📑
This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/vansh-codes/Gityzer/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
Contributors
We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating Gityzer to greater heights.
Here are the wonderful people who have contributed in [Gityzer](https://github.com/vansh-codes/Gityzer). You can see them here [CONTRIBUTORS.md](CONTRIBUTORS.md)
Make sure you show some love by giving ⭐ to our repository