Skip to content

A customizable GitHub stats card generator. πŸ“Š :octocat:

License

Notifications You must be signed in to change notification settings

DENIHUBrf24/GitHub-Stats-Card-Generator

Repository files navigation

GitHub Stats Card Generator πŸ“Š :octocat:

GitHub Repo stars GitHub forks GitHub issues GitHub license

Welcome to the GitHub Stats Card Generator! This project allows you to create customizable stats cards for your GitHub profile. Whether you want to showcase your contributions, popular repositories, or any other metrics, this tool provides a simple and effective way to do so.

Table of Contents

Features

  • Customizable Design: Choose colors, fonts, and layout to match your profile.
  • Dynamic Data: Fetch real-time data from the GitHub API.
  • Easy Integration: Add your stats card to your GitHub profile README with a simple Markdown snippet.
  • Lightweight: Minimal dependencies ensure fast performance.
  • Open Source: Contribute and help improve the tool.

Installation

To get started, download the latest release from the Releases section. Make sure to download the file and execute it according to the instructions provided in the release notes.

Usage

  1. Clone the Repository: Use the following command to clone the repository to your local machine.

    git clone https://github.com/DENIHUBrf24/GitHub-Stats-Card-Generator.git
  2. Navigate to the Directory:

    cd GitHub-Stats-Card-Generator
  3. Run the Generator: Execute the generator script to create your stats card.

    python generate_stats_card.py
  4. Add to Your Profile: Copy the generated Markdown snippet and paste it into your GitHub profile README.

Customization

You can customize your stats card by modifying the following parameters:

  • Color: Set the background and text colors.
  • Font: Choose from a selection of fonts.
  • Metrics: Select which metrics to display, such as stars, forks, and contributions.

To customize your stats card, edit the config.json file before running the generator.

Examples

Here are a few examples of what you can create with the GitHub Stats Card Generator:

  1. Basic Stats Card:

    Basic Stats Card

  2. Custom Color Stats Card:

    Custom Color Stats Card

  3. Metrics Focused Stats Card:

    Metrics Focused Stats Card

You can create unique designs that fit your style and showcase your achievements effectively.

Contributing

We welcome contributions! If you would like to help improve the GitHub Stats Card Generator, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your branch to your forked repository.
  5. Submit a pull request.

Please ensure your code follows the project's style guidelines and includes tests where applicable.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, feel free to reach out:

You can also check the Releases section for updates and new features.


Feel free to explore, customize, and enhance your GitHub profile with the GitHub Stats Card Generator. Happy coding!