為開源作者賦能,為此我花了一個月時間做了個工具平臺

鉑賽東發表於2021-03-10

前言

在介紹這個專案之前,先聽我BB幾句。

自己做開源也有2,3年了。現在也長期維護著3個開源專案,起初只是一時興趣,覺得做出一個東西放在開源站點上是一件很有意義的事。但是凡是用的人多了,自然會有各種各樣的問題和bug,各種issue要解決。自己的專案也如同自己的孩子一般,也不能放任不管,很多時候想放棄也不捨得。熬了兩年,發現開源事業絕不能只憑著一腔熱血,或者說光有一腔熱血還不夠,更需要是一些使命感和毅力去推動。這期間需要你花費大量的時間去解答群友的問題,迭代專案和經營。其實也不圖什麼,就圖那點成就感。

很多開源作者都是有本職工作的,只能利用業餘時間去幹這些事。這幾年也認識一些開源大佬,基本上一個長期維護優秀的開源作品的背後,一定有作者寫程式碼寫到凌晨的辛勞。就拿國內的Gitee的貢獻圖來說,放幾個大佬的貢獻圖,就知道他們有多努力

file

再放個更猛的:

file

看到這種貢獻圖,滿滿的綠,不由的發自內心的敬佩。接下去是我自己的,前半年純屬潛水。

file

想法

很多把自己的成果放在開源社群的小夥伴一定會有這樣的問題:我寫好一個開源專案,如何獲得開源專案的資料反饋來獲得更好的推廣呢。

其實自己做開源也碰到過這個問題,所以在一個月前和小夥伴一合計,開發了一個為開源作者賦能的工具平臺,並且這個平臺本身也是開源的。我們為這個平臺起了個名字:Giteye,寓意也很明確,希望做Git倉庫的眼睛,用資料和視覺化方式來給開源作者提供資料支援。

平臺地址:https://giteye.net

開源倉庫地址:https://gitee.com/giteye/open-giteye-api

file

Giteye希望給開源作者提供以下的支援:

1.提供開源者比較關心的Star趨勢,指數,貢獻者列表圖表,並且可選多種主題。生成的圖表可以掛到你的Git倉庫readme,或者站點主頁中。這個圖表是近似乎實時的。

2.以後會支援Gitee,Github兩大開源平臺。你的倉庫無論在哪個平臺都能從Giteye獲得資料支援。

3.為開源作者提供實時的訪問量資料,訪問IP統計,訪問來源統計,訪問地域統計,新老訪客資料等等。讓開源作者對自己的專案的訪問情況瞭如指掌。

4.可能很多開源作者都會很關心自己專案的Star數,Giteye可以近乎實時的通過服務號的方式推送給開發者誰star了你的專案。同時也會每天推送給你倉庫的訪問資料統計。

效能如何

giteye.net 最終生成的是png格式的靜態圖片,並不需要應用伺服器花資源和時間在每次請求的時候去動態實時生成,但會每10分鐘左右更新一次,更新時速度非常快。只需要一次在你這頁掛上圖片,就可以一直近乎實時的保持和倉庫資料的一致性。

你無需擔心頻寬問題,Giteye使用了全球CDN加速,資料圖表圖片顯示從任何地域載入都不會給您的首頁帶來額外負擔。

目前支援了些什麼功能

目前僅支援國內Gitee倉庫的資料圖表,Github的支援還在開發中。

在圖表能力方面 ,提供了多種主題的Star趨勢圖,Gitee指標圖,倉庫貢獻者列表。

訪問資料統計和倉庫資料推送,也還在開發中。

如何使用

Step1 瀏覽器輸入https://giteye.net進入首頁:

file

Step 2 關注後,即會自動登入,此服務號存在的目的是為了之後推送一些你倉庫的統計資料給到開源作者

file

Step 3 目前支援了Gitee的倉庫資料,需要你點選Gitee跳到官網進行授權,授權的目的是為了列出使用者的倉庫列表,而不用去手動輸入,Giteye只會去讀取,而不會進行任何其他操作。

7

8

Step 4 授權回來後,就進入我的圖表介面,如果你沒有進行過建立圖表,這裡不會有任何資料,點選右上角建立圖表進行建立

9

Step 5 點選建立圖表後,這裡會列出你Gitee賬戶下你所有的專案(fork和私有倉庫不包括在內),你也可以進行搜尋查詢你要生成圖表的專案

10

Step 6 點選某一個專案後,進入建立圖表介面,在這裡目前可以進行3種指標的建立,可以提供12種主題的選擇

11

Step 7 選擇相應的指標和主題後,點選生成。Giteye會去統計你的資料,後臺繪製圖表,Giteye後臺利用併發去拉取你的指標資料,但是如果你的star數有幾十k,還是要耐心等待1分鐘左右的時間

12

Step 8 圖表後臺繪製好,頁面能自動顯示圖表的預覽圖,你可複製底部的程式碼貼入你的README頁面或者任何你的主頁MD中,即可展示出你專案的資料。且這個圖是動態實時的,和你的專案資料時刻保持一致

13

14

15

最後

開發Giteye的初衷,一是國內包括Github此類為開源作者提供資料服務的工具站點並不多,二是對於開源作者來說,的確有痛點需要一個生成資料展示的平臺。我們也希望為開源者服務,並且希望中國優秀的開源專案越來越多,更加繁榮。如果你是一個開源作者,如果有此需求,請趕緊使用起來吧。

關於我

我是一個開源作者,也是一名內容創作者。「元人部落」是一個堅持做原創的技術科技分享號,會一直分享原創的技術文章,陪你一起成長。關注公眾號回覆liteflow能加入群聊,這裡有很多大佬能和你一起探討技術,回答你的問題。

wx

相關文章