Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minorcell/hub-io
Effortlessly access GitHub repository contributor information, with support for exporting as images or JSON, making it easier for open-source projects to showcase contributors.
https://github.com/minorcell/hub-io
contributors github json open-source readme repository rest-api
Last synced: about 4 hours ago
JSON representation
Effortlessly access GitHub repository contributor information, with support for exporting as images or JSON, making it easier for open-source projects to showcase contributors.
- Host: GitHub
- URL: https://github.com/minorcell/hub-io
- Owner: minorcell
- License: mit
- Created: 2025-01-27T14:33:27.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2025-02-09T07:21:52.000Z (3 days ago)
- Last Synced: 2025-02-09T08:23:40.358Z (3 days ago)
- Topics: contributors, github, json, open-source, readme, repository, rest-api
- Language: TypeScript
- Homepage: https://hub-io-mcells-projects.vercel.app/
- Size: 1.49 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hub-IO 🌟
Hub-IO: Easy access to github repository information
## Deployment 🖥️
Deployed on [[Hub-IO](https://hub-io-kappa.vercel.app/)](https://hub-io-mcells-projects.vercel.app/), click to visit!
## Introduction 🚀
Hub-IO is a web application designed to simplify the process of fetching contributor information from GitHub repositories. With Hub-IO, you can automatically retrieve contributor details, including their avatars, and export them as a synthesized image for your README file. Additionally, you can copy the contributor information in JSON format for further use. Whether you're managing an open-source project or just curious about your repository's contributors, Hub-IO has got you covered! 🎉
## Features ✨
Automatic Contributor Fetching: Simply input the GitHub repository URL, and Hub-IO will fetch the contributor information for you. 🕵️♂️
- Avatar Synthesis: Export contributor avatars as a single synthesized image, perfect for adding to your README file. 🖼️
- JSON Export: Copy contributor information in JSON format for easy integration with other tools or scripts. 📋
- User-Friendly Interface: Hub-IO is designed with simplicity in mind, making it easy for anyone to use. 🖥️
## How to Use 🛠️
1. Enter Repository URL: Navigate to the Hub-IO website and enter the GitHub repository URL you want to analyze.
2. Fetch Contributors: Click the "Query" button to retrieve the list of contributors.
3. Export Avatars: Choose the "Export Avatars" option to generate a synthesized image of all contributor avatars.
4. Copy JSON: Use the "Copy JSON" button to copy the contributor information in JSON format.
5. Update README: Download the synthesized image and add it to your README file to showcase your contributors! 📄
Example Usage 🖼️
Here’s an example of how you can use Hub-IO to generate a contributor avatar image for your README:
```markdown
# My Awesome Project
```
## Contributing 🤝
We welcome contributions from the community! If you'd like to contribute to Hub-IO, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.
Please ensure your code follows our coding standards and includes appropriate tests.
## Contributors 🥰
Generated by Hub-IO
## License 📜
Hub-IO is open-source software licensed under the MIT License. See the LICENSE file for more details.
## Acknowledgments 🙏
Thanks to GitHub for providing the API that makes this project possible.
Special thanks to all the contributors who have helped make Hub-IO a reality! 🌟
## Contact 📧
If you have any questions, suggestions, or just want to say hi, feel free to reach out to us at [mCell](mailto:[email protected])!.
Made with ❤️ by mCell