GitHub User Circle Generator Using GitHub Actions
MIT License
Oh My GitHub Circles
is a captivating visualization tool designed to showcase a user's friends on GitHub in a creatively arranged circle layout within an image. The friends are ranked based on various interaction metrics, fostering a sense of connection and community among GitHub users. This visually appealing image can be shared on social media or incorporated into your GitHub README profile to exhibit your network and interactions.
This tool visualizes a user's friends on GitHub in a circle arrangement within an image. Friends are ranked based on various interactions and their follower count. Assuming User A is the target user, the ranking for User B comprises the following points:
Besides the following interactions, the ranking also considers:
The ranking is established through these steps:
To summarize, oh-my-github-cicles
organizes a user's friends on GitHub in a circle layout image. The ranking of friends takes into account following relationships, PR, issue, and star scores, and the user's follower count.
Fork the repository: Start by forking this repository to your own GitHub account using the "Fork" button at the top right corner of the repository page.
Fill secrets for GitHub Actions: In the "Settings" tab of your forked repository, navigate to "Secrets" and add the following secrets:
3.1. USER_LOGIN
: Your target GitHub username.
3.2. DATABASE_URL
: Register for TiDB Serverless and get the connection info. You can register here: TiDB Serverless Registration
Format of the connection info: mysql2://<username>:<password>@<host>:<port>/<database>
3.3. ACCESS_TOKEN
: Create a GitHub Personal Access Token by following these instructions. โ ๏ธ If you fork this project to your personal account, the ACCESS_TOKEN is optional. However, if you fork this project to an organization, the ACCESS_TOKEN cannot be omitted.
Next:
Follow these steps, and you'll successfully set up "Oh My GitHub Circles" for your repository.
Oh My GitHub Circles was inspired by Chirpty, a similar visualization project for Twitter profiles. We would also like to express our gratitude to the following projects and services that played a crucial role in the development and implementation of Oh My GitHub Circles:
oh-my-github-pipeline: Our project depends on the oh-my-github-pipeline which is responsible for processing and transforming the GitHub user data.
GitHub Actions: GitHub Actions automates the entire workflow of our project, making it easy to build, test, and deploy the visualizations on demand.
TiDB Serverless: We leverage TiDB Serverless for seamless database management and highly efficient data handling, enabling a smooth user experience.
Contributions are always welcome! Feel free to fork the repo, make changes, and create pull requests.
This project is open-source and available under the MIT License. See the LICENSE file for more information.