Gityzer

KO | EN

gitlite — search

#react #python #android #javascript #nodejs #unity #hacktoberfest #linux #visualization #react-native #csharp #unity3d

★ 23 Open GitHub ↗

Generates personalized image summarizing your GitHub stats making your readme standout

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## 📑 Table of Contents

- [GITYZER](#gityzer)
- [Live Demo](#-live-demo)
- [Outreach](#-outreach)
- [Technologies Used](#technologies-used)
- [How it works](#how-it-works)
- [Project Structure](#✨-project-structure)
- [How to contribute ?](#how-to-contribute-)
- [Want to Contribute?](#want-to-contribute)
- [Project Admin](#project-admin-)
- [Code of Conduct](#code-of-conduct)
- [Contributors](#-contributors)

# **GITYZER**

<i>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.\*
</i>

<br>
<table align="center">
  <thead align="center">
    <tr border="1">
      <th>🤖 Project</th>
      <th>🌟 Stars</th>
      <th>🍴 Forks</th>
      <th>🐛 Issues</th>
      <th>🔔 Open PRs</th>
      <th>🔕 Close PRs</th>
      <th>👥 Contributors</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></td>
      <td><img src="https://img.shields.io/github/stars/vansh-codes/Gityzer?style=social"></td>
      <td><img src="https://img.shields.io/github/forks/vansh-codes/Gityzer"></td>
      <td><img src="https://img.shields.io/github/issues/vansh-codes/Gityzer"></td>
      <td><img src="https://img.shields.io/github/issues-pr/vansh-codes/Gityzer"></td>
      <td><img src="https://img.shields.io/github/issues-pr-closed/vansh-codes/Gityzer?color=critical"></td>
      <td><img src="https://img.shields.io/github/contributors/vansh-codes/Gityzer?color=blue"></td>
    </tr>
  </tbody>
</table>
</div>
<br>

## <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People%20with%20professions/Man%20Technologist%20Medium%20Skin%20Tone.png" alt="man-techno" height=50 width=50> 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:

<table>
  <tr>
    <th>Name</th>
    <th>Logo</th>
    <th>Purpose</th>
  </tr>

  <tr>
    <td>GSSoC'2024-Extd </td>
    <td><img src="https://github.com/user-attachments/assets/1bd8ab15-604e-4ac9-a33e-dc753a07be23" alt="GirlScriptSummerOfCode"></td>
    <td> The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform.</td>
  </tr>
  <tr>
    <td>Hacktoberfest 2024 </td>
    <td><img src="https://github.com/user-attachments/assets/027eb349-43f2-4834-9343-1e8ba0bf54ed" alt="logo of Hacktoberfest 2024"></td>
    <td> Hacktoberfest is a month-long October event welcoming all skill levels to join the open source community </td>
  </tr>
  <tr>
    <td>SWOC 2024</td>
    <td><img src="https://private-user-images.githubusercontent.com/80592559/400343793-eb175a0d-a4c4-4380-a971-fffb23288002.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzYxODUwMTUsIm5iZiI6MTczNjE4NDcxNSwicGF0aCI6Ii84MDU5MjU1OS80MDAzNDM3OTMtZWIxNzVhMGQtYTRjNC00MzgwLWE5NzEtZmZmYjIzMjg4MDAyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAxMDYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMTA2VDE3MzE1NVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWZkZTQ4MzU3NmI1MDk3ZTY4ZDI5MTA5Zjg0NDA4YjYyNTgyOGJhMzY4OTUzNzM0YjE1ZTI4NDdjZTdmZmIzYTkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.VaBTjMCkP4UW2VMe4hmU4V-zdxvYTtUKhaTPZIbMC5I" alt="SWOC 2024"></td>
    <td> Social Winter of Code introduces participants to open source through projects, mentorship, and workshops on development, AI, Web3, and more.</td>
  </tr>
</table>

## 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?<github_username>&update=14&style=dark&theme=dark&color=white
```

- `<github_username>`: 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!

<div align="left">
<h2><font size="6"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Handshake.png" alt="Handshake" width="40" height="40" /> Want to Contribute? </font></h2>
</div>
<br>

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.md) 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.md)._**

- 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!

<h1 align=center> Project Admin <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People%20with%20professions/Man%20Technologist%20Medium%20Skin%20Tone.png" alt="man-techno" height=40 width=40> </h1>

## 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.

</div>
<br>

<div align="center">
<h2><font size="6"><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /> Contributors </font></h2>
</div>
<br>

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

Gityzer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README