This repository is for the crawler app. Click here to see the front-end app.
太阁极客榜(or BitTiger Geeks Ranking)is a real-time ranking board for BitTiger's Github members. Its results are based on members' Github activities in the past seven days with daily updates at 06:30 PDT.
Demo: https://bittiger-ranking.firebaseapp.com
By showing the Github members' activities in a game-style ranking board, we can finally help the github members grow their interests and get more engaged in coding.
We intentionally introduce some top coders in our ranking board just to have more fun;)
This project consists of three components:
- A crawler to dig the members' public data and calculates their rankings.
- A Firebase-powered persistence layer for the results from the crawler.
- A front-end single-page app to show the members' rankings from the persistence layer.
To start the application:
npm install
node launcher.js
To crawl the github data and update the ranking history(user_ranking_info
) to database(Firebase):
localhost:port/crawl
To crawl the github data but NOT update the ranking history(user_ranking_info
) to database(Firebase). We only update the ranking history in production scenario.
localhost:port/test
Note You have to configure your own github account and firebase secret in ./configs/account.js
Firebase URL: https://bittiger-ranking.firebaseio.com
bittiger-ranking
|__ + user_events
|__ + user_ranking_info
user_events
is the data displayed on the ranking board. The data is set by the crawler app and retrieved by the front-end web app.
created_time
: the most recent update timeevents
: a sorted array of the latest user dataevent - <number> - ranking_history
: the user's most recent 10 rankings
user_events
|__ created_time: "2016-05-09T18:37:44-07:00"
|__ + events
|__ + 0
|__ + 1
|__ CreateEvent: 11
|__ ForkEvent: 4
|__ PullRequestEvent: 6
|__ PushEvent: 23
|__ Total: 44
|__ avatar_url: "https://avatars.githubusercontent.com/u/7756581?v=3"
|__ html_url: "https://github.com/hackjustu"
|__ login: "hackjustu"
|__ organization: "bittiger"
|__ ranking_change: 0
|__ + ranking_history
|__ + 0
|__ + 1
|__ ranking: 3
|__ timestamp: "2016-05-09T06:30:03-07:00"
user_ranking_info
helps store users' most recent 100 ranking history. As now, this data is only used by the crawler app.
<user1's login>
: Usually we call it the username for the Github member. It is the same value as shown in the previoususer-events - events - <number> - login
user_ranking_info
|__ + <user1's login>
|__ + <user2's login>
|__ + hackjustu
|__ + 0
|__ + 1
|__ ranking: 3
|__ timestamp: "2016-05-08T06:30:03-07:00"
We compare Total
, PushEvent
, PullRequestEvent
, CreateEvent
and ForkEvent
in sequence and stop at the first available result.
Total = PushEvent + PullRequestEvent + CreateEvent + ForkEvent
Note: If you have multiple commits in one push event, we still count it one score. People have suggested using the number of
commit
instead ofpush
. We could probably adopt this some time, but at this moment, we still countpush
.
Users can sort the members by other order such as just PushEvent
or ForkEvent
, but we use the ranking of Total
for our medal system in the next section.
We adopt Clash of Clans's medal system for fun, beacasue we love the game~~
Medal | Icon | Scores (Total) |
---|---|---|
Champion | > 100 | |
Gold | 50 - 100 | |
Silver | 20 - 50 | |
Bronze | < 20 |
Note: If you are Super Cell and feel unhappy about how your lovely medal icons are used here, please just let me know. I'm more than happy to change them.
Cosmo |
- Project Wukong contributes the prototype for the backend github crawler.
- Freepik contributes several cool free images.
- category: full stack
- team: Fighting Falcon
- description: A real-time ranking board for BitTiger's Github members.
- stack: nodejs, firebase