github-rank/README.md at master

mirror/github-rank

Fork 0

mirror of https://github.com/jaywcjlove/github-rank.git synced 2025-12-20 01:14:47 +08:00

Files

github-actions[bot] 02caebcfd0 doc: update README.md.

2025-12-15 00:56:52 +00:00

14 KiB

Raw Permalink Blame History

^{Special thanks to:}
You’re welcome to advertise here :)

^{Using my app is also a way to support me:}

Github global/Chinese user rankings, global repositories Star rankings, page data generated through Github API v3, ranking preview.

Released on npm from April 20, 2019, the version number is defined by year, month, and day, such as: v19.4.20.

Warning

Due to the large number of projects, the free quota is insufficient, resulting in some charges. We have now adjusted it to run every 7 days to save costs.

Now it can be updated automatically every day, using GitHub Actions Workflows to trigger the GitHub workflow every day at 00:00 (8:00 am Beijing time) through the timer, automatically crawl the data, submit the generated web page to the gh-pages branch, and Automatically publish npm version, really fragrant! !

Update date: 2025-12-15 00:56:51

Plug-in Usage

npm install @wcj/github-rank --save-dev

Users can obtain ranking data by importing data, or directly access the user leaderboard through UNPKG.

import users from '@wcj/github-rank';
import repos from '@wcj/github-rank/dist/repos.json';
import trendingDaily from '@wcj/github-rank/dist/trending-daily.json';
import trendingWeekly from '@wcj/github-rank/dist/trending-weekly.json';
import trendingMonthly from '@wcj/github-rank/dist/trending-monthly.json';

import users from '@wcj/github-rank';

// By default users outputs the following data:
[
  {
    "login": "jaywcjlove",
    "id": 1680273,
    "node_id": "MDQ6VXNlcjE2ODAyNzM=",
    "avatar_url": "https://avatars1.githubusercontent.com/u/1680273?v=4",
    "gravatar_id": "",
    "url": "https://api.github.com/users/jaywcjlove",
    "html_url": "https://github.com/jaywcjlove",
    "followers_url": "https://api.github.com/users/jaywcjlove/followers",
    "following_url": "https://api.github.com/users/jaywcjlove/following{/other_user}",
    "gists_url": "https://api.github.com/users/jaywcjlove/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/jaywcjlove/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/jaywcjlove/subscriptions",
    "organizations_url": "https://api.github.com/users/jaywcjlove/orgs",
    "repos_url": "https://api.github.com/users/jaywcjlove/repos",
    "events_url": "https://api.github.com/users/jaywcjlove/events{/privacy}",
    "received_events_url": "https://api.github.com/users/jaywcjlove/received_events",
    "type": "User",
    "site_admin": false,
    "score": 1,
    "rank": 117,
    "name": "小弟调调™",
    "company": "ʕ•̫͡•ʔ-̫͡-ʕ•͓͡•ʔ-̫͡-ʔ",
    "blog": "http://wangchujiang.com",
    "location": "Shanghai, China",
    "email": "wowohoo@qq.com",
    "hireable": true,
    "bio": "(͡·̮̃·̃) 撸码的乐趣 💯 ，“人没了，™代码还在”",
    "public_repos": 78,
    "public_gists": 1,
    "followers": 2519,
    "following": 91,
    "created_at": "2012-04-26T00:30:25Z",
    "updated_at": "2019-04-12T14:27:54Z"
  }
]

Development

$ git clone https://github.com/jaywcjlove/github-rank.git
$ cd github-rank
$ npm install   # Install dependencies
$ npm run build # Compilation output script

Crawlers get data

$ npm run get:trending    # Get trending data
$ npm run get:repos       # Get repos data
$ npm run get:users       # Get users data
$ npm run get:users:china # Get users(china) data

Generate HTML page