dotcom-rendering 的安装和配置教程

1. 项目基础介绍和主要编程语言

dotcom-rendering 是 The Guardian 的一个开源项目，用于渲染该网站上的文章。这个项目是一个单体仓库（monorepo），包含了两个项目：apps-rendering 和 dotcom-rendering。它主要用于处理网页上的内容展示逻辑。主要使用的编程语言是 TypeScript，同时也包含一些 JavaScript 代码。

2. 项目使用的关键技术和框架

该项目使用了一系列的关键技术和框架来确保高效的开发与性能，主要包括：

• TypeScript: 提供静态类型检查，增强代码的可维护性和可读性。
• Node.js: 作为 JavaScript 的运行时环境，用于执行服务器端代码。
• fnm: 用于管理 Node.js 的多个版本。
• corepack: 用于管理项目的包管理器。
• pnpm: 作为项目的包管理工具，用于安装和管理项目依赖。
• Storybook: 用于开发组件和 UI 的沙箱环境。
• Chromatic: 用于视觉回归测试。

3. 项目安装和配置的准备工作及详细步骤

在开始安装之前，请确保你的系统已经安装了以下软件：

• Git：用于克隆和操作项目代码。
• Node.js 和 npm：Node.js 运行时环境和包管理工具。

以下是详细的安装步骤：

步骤 1：克隆项目

首先，你需要从 GitHub 上克隆项目仓库到本地计算机：

git clone https://github.com/guardian/dotcom-rendering.git
cd dotcom-rendering

步骤 2：安装 Node.js 版本管理工具

推荐使用 fnm 来管理 Node.js 的不同版本。你可以通过以下命令安装 fnm：

curl -fsSL https://fnm.vercel.app | bash

安装完成后，你需要重启你的终端或者执行 source ~/.bashrc（或对应的 shell 配置文件）来使 fnm 可用。

步骤 3：设置 Node.js 版本

使用 fnm 来安装和切换到项目推荐的 Node.js 版本：

fnm install <version> # 替换 <version> 为项目推荐的 Node.js 版本
fnm use <version> # 同上

步骤 4：启用 corepack

启用 corepack 来管理项目的包管理器：

corepack enable

如果你使用 asdf，在执行 corepack enable 后需要运行 asdf reshim nodejs。

步骤 5：安装依赖

在项目根目录下运行以下命令来安装所有依赖：

pnpm install

步骤 6：开始使用项目

根据你的需要，进入相应的子目录来运行项目。例如，如果你想运行 dotcom-rendering 的开发服务器，可以：

cd dotcom-rendering
make dev

以上就是 dotcom-rendering 的安装和配置教程。按照这些步骤操作，你就可以在自己的计算机上开始开发这个项目了。