The Guardian Dotcom Rendering 开源项目最佳实践

The Guardian Dotcom Rendering 开源项目最佳实践

dotcom-rendering The Guardian web rendering service 项目地址: https://gitcode.com/gh_mirrors/do/dotcom-rendering

1. 项目介绍

The Guardian Dotcom Rendering（简称DCR）是一个开源项目，它是The Guardian网站的文章渲染逻辑的实现。该项目是一个monorepo，包含两个子项目：apps-rendering 和 dotcom-rendering。DCR 使用 TypeScript 和 JavaScript 编写，致力于为The Guardian网站提供高效、稳定的内容渲染服务。

2. 项目快速启动

环境准备

• 安装 Node.js：推荐使用 fnm（Fast Node Manager）来管理多个版本的 Node.js。在设置 fnm 时，可以添加 --version-file-strategy recursive 选项，以便在当前目录或任何父目录中找到并设置活动的 Node 版本。
• 启用 corepack：运行 corepack enable 来确保使用正确的包管理器。

安装依赖

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

pnpm install

运行项目

• 对于 dotcom-rendering 项目，先切换到该项目的子目录，然后运行：

cd dotcom-rendering
make dev

• 对于 apps-rendering 项目，同样先切换到该项目的子目录，然后运行：

cd apps-rendering
pnpm watch

Storybook/Chromatic

• 运行 Storybook 来查看所有项目：

pnpm storybook

• 构建 Storybook：

pnpm build-storybook

• 运行 Chromatic 进行视觉回归测试：

cd dotcom-rendering
pnpm chromatic -t [CHROMATIC PROJECT TOKEN]

注意：将 [CHROMATIC PROJECT TOKEN] 替换为你的 Chromatic 项目令牌。

3. 应用案例和最佳实践

模块化开发

DCR 鼓励模块化开发，每个功能或组件都应该独立且可重用。确保你的代码遵循单一职责原则。

代码风格

使用 Prettier 和 ESLint 来保持代码风格的一致性和错误检查。

单元测试

编写单元测试来确保代码的稳定性和可维护性。使用 Jest 或其他测试框架来执行测试。

持续集成

集成 CI/CD 流程来自动化测试和部署过程，确保代码质量和项目的稳定性。

4. 典型生态项目

• The Guardian Website：The Guardian 的官方网站，使用 DCR 进行内容渲染。
• Open Source Projects：其他开源项目可以借鉴 DCR 的架构和代码风格，实现高效的内容渲染。

以上就是 The Guardian Dotcom Rendering 开源项目的最佳实践方式，希望对您的开发工作有所帮助。

dotcom-rendering The Guardian web rendering service 项目地址: https://gitcode.com/gh_mirrors/do/dotcom-rendering