https://github.com/idealclover/GitHub-Star-Counter

✨An API to count a GitHub user's total stars, working with shield.io.
https://github.com/idealclover/GitHub-Star-Counter

Last synced: 3 months ago
JSON representation

✨An API to count a GitHub user's total stars, working with shield.io.

• Host: GitHub
• URL: https://github.com/idealclover/GitHub-Star-Counter
• Owner: idealclover
• License: mit
• Created: 2020-02-19T17:35:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T16:21:04.000Z (about 2 years ago)
• Last Synced: 2024-08-03T21:04:25.890Z (7 months ago)
• Language: TypeScript
• Homepage: https://api.github-star-counter.workers.dev/user/idealclover
• Size: 451 KB
• Stars: 87
• Watchers: 2
• Forks: 10
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub-Star-Counter

> ✨ City of stars, are you shining just for me?

## What Is It

An API to count a GitHub user's total stars.

> /user/:username - to show a user's total stars and forks of is repositories.

For example: [https://api.github-star-counter.workers.dev/user/idealclover](https://api.github-star-counter.workers.dev/user/idealclover)

Heroku version: [https://github-star-counter.herokuapp.com/user/idealclover](https://github-star-counter.herokuapp.com/user/idealclover)

Moreover, you can combined it with [shields.io](https://shields.io/) to produce a badge like this:

![](https://img.shields.io/badge/dynamic/json?logo=github&label=GitHub%20Stars&style=for-the-badge&query=%24.stars&url=https://api.github-star-counter.workers.dev/user/idealclover)

![](https://img.shields.io/badge/dynamic/json?logo=github&label=GitHub%20Forks&style=for-the-badge&query=%24.forks&url=https://api.github-star-counter.workers.dev/user/idealclover)

Sometimes due to slow network, the pictures above could not show correctly, here are the static version:

![](https://github.com/idealclover/GitHub-Star-Counter/raw/master/assets/pic1.svg?sanitize=true)

![](https://github.com/idealclover/GitHub-Star-Counter/raw/master/assets/pic2.svg?sanitize=true)

## Deploy

### On Heroku

In order to increase the API rate limit, you can register GitHub auth code [here](https://github.com/settings/tokens)

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/idealclover/GitHub-Star-Counter/tree/heroku)

### On Cloudflare Worker

This is a serverless function deployed on Cloudflare Workers. Please check: [Quick Start | Cloudflare Workers](https://developers.cloudflare.com/workers/quickstart) if you want to deploy or contribute.

## LICENSE

Inspired by [yyx990803/starz](https://github.com/yyx990803/starz).

Thanks for strong support by [fengkx](https://github.com/fengkx)!

MIT LICENSE. Have fun.