微人事 star 數超 10k，如何打造一個 star 數超 10k 的開源項目

看了下，微人事(https://github.com/lenve/vhr)... star 數超 10k 啦，鬆哥第一個 star 數過萬的開源項目就這樣誕生了。

兩年前差很少就是如今這個時候，鬆哥所在的公司業績下滑嚴重，關門倒閉已成定局，不少同事在謀劃的新的出路，鬆哥則被公司留下來善後，在一段並不太忙碌的日子裏，作了兩個 Spring Boot + Vue 的先後端分離開源項目，以期能給本身來年找工做增長一點籌碼，沒想到這兩個項目後來受到不少關注，也幫助了不少人。有很多小夥伴在公司使用微人事項目作腳手架開發項目，也有國內 top20 的高校研究生借鑑微人事作畢設，我本身也所以收到一些大廠的橄欖枝，能夠說仍是收穫滿滿。

關於這個項目誕生的故事，鬆哥以前寫過一篇文章，感興趣的小夥伴能夠看看：

• 公司倒閉 1 年了，而我當年的項目上了 GitHub 熱榜

今天，我想和小夥伴們聊聊如何從零開始打造一個 star 數過萬的開源項目。鬆哥把這些經驗總結爲三點：

• 文檔詳細
• 項目有料
• 適當宣傳

這些經驗不是什麼驚世駭俗的大道理，都很普通，關鍵在於執行。

1. 文檔詳細

其實在作微人事和 V 部落以前，鬆哥在 GitHub 上已經作過多個開源項目了，比較有意思的一個是一個 Android 上的自定義控件，我作了一個歌詞展現的控件，這個控件引入到本身的項目中之後，能夠根據當前歌曲的播放進度動態滾動歌詞，效果如以下：

還有一個比較好玩的就是 Android 上自動搶紅包的 App。不過這些開源工具和項目最終都石沉大海了。

究其緣由，我以爲是本身對待這些項目不夠認真，項目開源以後基本上都沒有再繼續維護了，一個項目提交次數通常都是個位數，項目作完以後，寫一篇博客介紹下就算完事了。一個本身都不怎麼重視的項目，其實很難引發別人的重視。

因此在 V 部落和微人事中，我就吸收教訓，儘可能把項目的文檔寫的詳細一些，讓不懂先後端分離開發的小夥伴看到我寫的開發文檔後，就可以快速理清項目的思路。就這樣，我每寫一個功能點，就寫一篇技術文檔，微人事項目前先後後一共寫了 30 多篇文檔：

同時我考慮到不少小夥伴第一次接觸到這個項目，一個龐然大物很差處理，所以我在每一次項目提交以前，都會對項目打一個 tag，這樣你們經過 git clone 命令獲取到項目以後，就能夠經過 tag 很是方便的定位到項目的任意時刻，例如只想看登陸設計的，能夠根據文檔介紹回到 v20180107 這個版本：

小夥伴也能夠點擊 GitHub 上的 release 下載不一樣時期的項目。我一開始擔憂有的小夥伴不熟悉 Git 上的 tag 操做，還針對此寫了個教程，就是上面文檔的第 17 篇。

能夠說，這個項目我從頭至尾考慮了不少小夥伴們可能遇到的問題，不是自嗨，確實是但願可以帶着小夥伴們一塊兒飛。

這麼詳細的文檔固然也獲得了小夥伴和一些平臺的承認，項目剛剛發佈的時候，也就是 2018 年年初的時候，慕課網在它的官方知乎帳號、微博帳號上都有推過個人介紹項目的文章，當時這個項目就受到了不少小夥伴的關注，收穫了很多 star，小夥伴們的關注也鼓勵我繼續把這個項目向前推動。

這是我介紹的第一點經驗，文檔詳細。

2. 項目有料

項目有料，也就是這個項目對你們而言是有價值的，可以真正幫到你們。

不少小夥伴看到微人事會以爲奇怪，這個項目還有一些功能沒有實現，怎麼就有這麼多人關注呢？其實緣由很簡單，這個項目的價值不在於它的業務，而在於它解決了不少小夥伴在先後端分離開發中遇到的問題，這也是我作這個項目的初衷之一。

做爲一個 Java 攻城獅，我很是明白不少小夥伴去接觸 Vue、接觸 Nodejs、接觸 SPA 以及接觸前端工程化這些概念時所面臨的困惑，由於這些困惑我也曾經遇到過。

例如先後端分離後，開發環境下先後端如何進行數據交互、權限管理怎麼作、文件上傳怎麼作、項目怎麼部署等等，事無鉅細，我以爲小夥伴們可能會困惑的地方，我在微人事中直接用代碼作出樣例，而後再輔以詳細的文字解釋，這樣對於大部分小夥伴而言，都可以快速理解這個項目了。

這個項目創建之初，一開始就定位是一個學習項目，目的就是幫助你們創建先後端分離開發知識體系，搞定先後端分離開發中常見的坑，所以，一旦將項目的框架搭建成功，你們理解了先後端分離架構中的各個細節，剩下的業務不過是堆代碼，技術上已經沒有挑戰了，這也是這個項目最近一段時間更新慢的緣由。

這是我和你們分享的第二點經驗，項目要有價值。

3. 適當宣傳

微人事和 V 部落剛剛上線的時候，個人相關文章被慕課網猛推過幾回，當時就讓微人事受到了比較多的關注，印象中，大概不到一個月的時間，star 數就超過 1k 了。

因爲文檔比較詳細，不少大佬在整理相關資料的時候都會加上微人事項目，不少小夥伴可能見過標題相似下面這樣的文章：

• 13個優秀的 Spring Boot 學習項目
• 開源的13個Spring Boot 優秀學習項目！
• 六月份 GitHub 上最受歡迎的開源項目
• 七月份 GitHub 上最受歡迎的開源項目

....

這一類的文章大部分都會收錄微人事項目，進而將微人事項目曝光給更多小夥伴去學習。

今年七月份，有感於 1 年前公司倒閉時的無助，鬆哥寫了一篇文章介紹了微人事項目的誕生過程：

• 公司倒閉 1 年了，而我當年的項目上了 GitHub 熱榜

沒想到這篇文章被不少大佬轉發，單單在知乎上這篇文章的閱讀量就超過 12w，那一段時間，微人事項目也被不少有須要的小夥伴關注到了。

宣傳這一塊，個人經驗是若是項目確實幫助到了不少小夥伴，對不少人而言有價值，你會發現平臺，一些有影響力的技術牛人會天然的幫你推。因此，我仍是建議將重心放在項目上。所謂家有梧桐樹，引得鳳凰來。

這是我介紹的第三點經驗，適當宣傳。

好了，一點點不太成熟的經驗分享給小夥伴們，但願能幫到你們。
關注公衆號【江南一點雨】，專一於 Spring Boot+微服務以及先後端分離等全棧技術，按期視頻教程分享，關注後回覆 Java ，領取鬆哥爲你精心準備的 Java 乾貨！