Peridot 项目使用教程

1. 项目目录结构及介绍

Peridot 项目的目录结构如下：

peridot/
├── apollo/
├── bases/
├── build/
├── ci/
├── common/
├── config/
├── docs/
├── dotui/
├── google/
├── hack/
├── hydra/
├── infrastructure/
├── initdb/
├── kojikoji/
├── modulemd/
├── nofussvendor/
├── obsidian/
├── patches/
├── peridot/
├── platforms/
├── proto/
├── protoc-gen-openapiv2/
├── rules_raw_ts_library/
├── rules_resf/
├── servicecatalog/
├── spicedb/
├── tailwind/
├── temporalutils/
├── third_party/
├── tools/
├── utils/
├── validate/
├── vendor/
├── views/
└── wrksp/

目录介绍

• apollo/: 错误镜像和发布平台。
• bases/: 基础组件。
• build/: 构建相关文件。
• ci/: 持续集成相关文件。
• common/: 通用工具和库。
• config/: 配置文件。
• docs/: 项目文档。
• dotui/: UI 相关文件。
• google/: Google 相关工具和库。
• hack/: 开发工具和脚本。
• hydra/: Hydra 相关文件。
• infrastructure/: 基础设施相关文件。
• initdb/: 数据库初始化文件。
• kojikoji/: Kojikoji 相关文件。
• modulemd/: Modulemd 解析器。
• nofussvendor/: 供应商相关文件。
• obsidian/: Obsidian 相关文件。
• patches/: 补丁文件。
• peridot/: 现代构建系统。
• platforms/: 平台相关文件。
• proto/: Protobuf 相关文件。
• protoc-gen-openapiv2/: OpenAPI 生成器。
• rules_raw_ts_library/: TypeScript 库规则。
• rules_resf/: Resf 规则。
• servicecatalog/: 服务目录相关文件。
• spicedb/: Spicedb 相关文件。
• tailwind/: Tailwind CSS 相关文件。
• temporalutils/: Temporal 工具。
• third_party/: 第三方库。
• tools/: 工具集。
• utils/: 通用工具。
• validate/: 验证工具。
• vendor/: 供应商文件。
• views/: 视图文件。
• wrksp/: 工作区文件。

2. 项目启动文件介绍

Peridot 项目的启动文件主要集中在 hack/ 目录下，其中包含了用于启动开发环境和服务的脚本。以下是一些关键的启动文件：

• hack/deploy_dev_registry: 用于部署开发环境中的注册表。
• hack/setup_external_dev_services: 用于设置外部开发服务。
• hack/setup_k8s_dev_env: 用于设置 Kubernetes 开发环境。
• hack/setup_dev_temporal: 用于设置开发环境中的 Temporal。
• hack/setup_base_internal_services: 用于设置基础内部服务。

3. 项目配置文件介绍

Peridot 项目的配置文件主要集中在 config/ 目录下，以下是一些关键的配置文件：

• config/bazelrc: Bazel 配置文件。
• config/editorconfig: 编辑器配置文件。
• config/envrc: 环境配置文件。
• config/gitlab-ci.yml: GitLab CI 配置文件。
• config/prettierrc: Prettier 配置文件。
• config/yarnrc.yml: Yarn 配置文件。

这些配置文件用于定义项目的构建、开发环境和持续集成等设置。

---

以上是 Peridot 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Peridot 项目。