FAQ

Here you'll find answers to common questions about the GitHub Bubble Chart project. If you have a question that isn't covered here, feel free to open an issue on GitHub!

💡 General Questions

What is GitHub Bubble Chart?

GitHub Bubble Chart is a visualization tool that generates interactive bubble charts based on GitHub repository data. It helps users analyze the most used programming languages or display custom datasets in a visually appealing way.

How can I use this project?

You can directly use the API that's already deployed at https://github-bubble-chart.vercel.app by accessing it with the necessary parameters. Alternatively, you can deploy this project on your own Vercel or any other hosting platform that supports Node.js applications.

⚙️ Configuration & Customization

How do I customize the chart appearance?

You can customize the chart using API URL parameters such as width, height, theme, and more. Otherwise, you can use a custom configuration JSON file to define specific settings.

How do I use a custom configuration?

To use a custom configuration, set the mode parameter to custom-config and provide the config-path to your JSON file in your repository:

https://github-bubble-chart.vercel.app?username=teociaps&mode=custom-config&config-path=config.json

See the Configuration page for details on how to customize your chart.

What themes are available?

Please visit the Themes page to know more about themes.

🛠️ Troubleshooting

Why is my chart not loading?

Check the following:

1. Ensure the GitHub username parameter is correct.
2. Verify that your custom configuration file (if used) is valid and accessible.
3. Make sure you haven’t exceeded the GitHub API rate limit.

Why are some languages missing from my chart?

The chart pulls data based on the top languages used in your repositories. If certain languages are missing, they might not be significant enough based on your overall repository data. You can adjust the langs-count parameter to include more languages.

Why are some language icons missing in my chart?

When using the default top-langs mode, language icons are sourced from Devicons. Not all programming languages have icons in this library, especially newer or less common languages. The chart will still display these languages correctly, just without an icon. If you're using custom-config mode, you can provide your own custom icons either as direct image URLs or as base64-encoded images.

If you find missing icons for languages you use, you can open an issue on our GitHub repository or contribute directly to the Devicons repository to add support for that language.

My custom theme is not working. What should I do?

1. Ensure your theme follows the correct structure of the ThemeBase class.
2. Check that your theme is properly imported and registered in the project.
3. If you added a new theme, restart your deployment to apply changes.

🚀 Contributions

How can I contribute to this project?

Follow the guidelines here.

Can I add a new theme to the project?

Yes! Follow the theme creation guidelines.

---

Still have questions?

• Open a discussion in the Discussions tab.
• Reach out by opening an issue with a question label.