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。

支持

要报告错误，建议改进或提出问题，请引起问题。