https://github.com/xilaluna/git-pinned
A lightweight go scraper that scrapes github profiles for pinned repos
https://github.com/xilaluna/git-pinned
api github go golang scraper
Last synced: about 2 months ago
JSON representation
A lightweight go scraper that scrapes github profiles for pinned repos
- Host: GitHub
- URL: https://github.com/xilaluna/git-pinned
- Owner: xilaluna
- License: mit
- Created: 2023-04-02T22:51:13.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T21:21:02.000Z (over 2 years ago)
- Last Synced: 2025-01-30T08:16:16.016Z (over 1 year ago)
- Topics: api, github, go, golang, scraper
- Language: Go
- Homepage: https://git-pinned-production.up.railway.app/
- Size: 22.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-pinned
A simple go scraper that gets all of your pinned repos on GitHub via an API endpoint.
## 📑 About
git-pinned is a simple go scraper that is running on a gin server. It is designed to be used as an API endpoint to get all of your pinned repos on GitHub. It is currently being used on my [portfolio](https://xilaluna.com/projects). I initially made it for this reason, but I figured it would be useful for others as well. Feel free to fork or clone this repo. If you have any suggestions or issues, please open an issue or pull request.
## 📚 Stack
- [Go](https://golang.org/)
- [Gin](https://gin-gonic.com/)
- [Colly](https://go-colly.org/)
- [Railway](https://railway.app/)
## 🧑💻 How to Use
The most basic route defaults to my account and gets my pinned repos. Feel free to change this in the `main.go` file.
```
api/
```
The next api route allows you to enter your username after the slash and fetch the pinned repos for that specific user.
```
api/:username
```
In both cases, the response will be a JSON object with the following structure:
```JSON
[
{
"title": "repo-name",
"description": "repo-description",
"link": "repo-link",
"language": "repo-language",
"stars": "repo-stars",
"forks": "repo-forks"
},
]
```
## 🪪 License
Licensed under the [MIT License](./LICENSE).
If you use this project, please just give the project a star. Thanks!