10kbclub

10 KB俱樂部

注意：該項目不再維護。

這是10KBClub.com的源代碼。

內容

• 建議新網站
• 開發設置
• 提出準則
• 其他詳細信息
• 執照
• 支持

建議新網站

首先閱讀俱樂部規則。如果新網站滿足俱樂部規則，請創建一個新問題並提供網站的URL。

開發設置

要在本地構建和開發該項目，請執行以下步驟：

1. 克隆這個存儲庫：

   git clone https://github.com/susam/10kbclub.git

2. 安裝節點。

   在MacOS上，如果您有自製的話，請輸入以下命令：

   make mac-setup

   在Debian，Ubuntu或另一個基於Debian的Linux系統上，輸入以下命令：

    make deb-setup
   

3. 輸入以下命令創建網站的本地副本：

   make render

4. 現在，使用Web瀏覽器打開index.html以查看輸出。

發展活動

1. 在Linux系統上，輸入以下命令，以確保將節點二進製文件的目錄添加到PATH環境變量：

    . ./env

2. 輸入以下命令以生成一個名為metrics.yaml的文件，該文件將包含文件src/urls.yaml中每個URL的指標數據：

   node src/refresh.js

3. 輸入以下命令，使用metrics.yaml中的數據渲染主頁：

   node src/render.js

4. 輸入以下命令獲取單個URL並打印其指標：

   node src/metrics.js https://www.example.com/

   該腳本還接受這樣的多個URL論點：

   node src/metrics.js https://www.example.com/ https://www.example.org/

提出準則

在手動提交的提交中遵循以下準則：

1. 以下命令應在沒有錯誤的情況下成功：

   make checks
   make render

2. 提交消息是按照本文檔中的準則編寫的：編寫良好的提交消息。

其他詳細信息

本節包含一些其他細節，這些詳細信息可能有助於理解該項目。

1. https://github.com/susam/10kbclub的項目存儲庫自動發佈為https://10kbclub.com/使用github頁面。

2. 發布該網站的構建工作每週六以及通過github動作自動運行一次。有關github操作工作流程，請參見live.yml 。請參閱https://github.com/susam/10kbclub/actions，以了解工作流的先前執行。

3. js/urls.yaml中討論線程的鏈接並不詳盡。從每個論壇中選擇了有100點或更多點的最早的5個最早的討論線程。

執照

這是免費的開源軟件。您可以根據麻省理工學院許可條款使用，複製，修改，合併，發布，分發，轉銷和/或出售其副本。有關詳細信息，請參見License.MD。

該軟件是“原樣”提供的，沒有任何形式的明示或暗示保修。有關詳細信息，請參見License.MD。

支持

要報告錯誤，建議改進或提出問題，請引起問題。