网站导航
> 技术文档 > Substrate Connect 项目教程

Substrate Connect 项目教程

网友: 技术文档 2025-07-30 13:12:07

Substrate Connect 项目教程

1. 项目的目录结构及介绍

Substrate Connect 项目的目录结构如下：

substrate-connect/├── CONTRIBUTING.md├── DEPLOY-RELEASE.md├── LICENSE├── README.md├── package.json├── pnpm-lock.yaml├── pnpm-workspace.yaml├── tsconfig.base.json├── tsconfig.build.json├── turbo.json├── typedoc.json├── vitest.config.ts├── examples/│ └── ...├── packages/│ ├── @substrate/connect/│ ├── @substrate/connect-known-chains/│ ├── @substrate/connect-discovery/│ └── @substrate/smoldot-discovery/├── projects/│ ├── demo/│ └── extension/└── ...

目录结构介绍

  • CONTRIBUTING.md: 贡献指南文件，包含如何为项目贡献代码的说明。
  • DEPLOY-RELEASE.md: 部署和发布指南文件，包含如何发布新版本的说明。
  • LICENSE: 项目许可证文件，采用 GPL-3.0 许可证。
  • README.md: 项目介绍文件，包含项目的基本信息和使用说明。
  • package.json: 项目的包管理文件，定义了项目的依赖和脚本。
  • pnpm-lock.yaml: 锁定文件，确保依赖版本的稳定性。
  • pnpm-workspace.yaml: 工作区配置文件，定义了多个包的管理方式。
  • tsconfig.base.json: TypeScript 基础配置文件。
  • tsconfig.build.json: TypeScript 构建配置文件。
  • turbo.json: Turbo 配置文件，用于管理构建和开发流程。
  • typedoc.json: TypeDoc 配置文件，用于生成文档。
  • vitest.config.ts: Vitest 配置文件，用于单元测试。
  • examples/: 示例代码目录，包含使用 Substrate Connect 的示例项目。
  • packages/: 核心包目录，包含多个子包，如 @substrate/connect 和 @substrate/smoldot-discovery。
  • projects/: 项目目录，包含完整的实现项目，如 demo 和 extension。

2. 项目的启动文件介绍

Substrate Connect 项目的启动文件主要位于 projects/ 目录下，特别是 projects/extension/ 和 projects/demo/ 目录。

启动文件介绍

  • projects/extension/src/index.ts: 扩展项目的入口文件，负责初始化和启动浏览器扩展。
  • projects/demo/src/index.ts: 演示项目的入口文件，负责初始化和启动演示应用程序。

启动流程

  1. 安装依赖: 使用 corepack pnpm install 安装所有依赖。
  2. 启动扩展: 在终端 A 中运行 cd projects/extension && corepack pnpm dev，然后在终端 B 中运行 cd projects/extension && corepack pnpm start。
  3. 启动演示应用: 在终端 C 中运行 cd projects/demo && corepack pnpm dev，然后在浏览器中访问演示应用的 URL。

3. 项目的配置文件介绍

Substrate Connect 项目的配置文件主要位于项目根目录和各个子包目录中。

配置文件介绍

  • package.json: 定义了项目的依赖、脚本和元数据。
  • pnpm-workspace.yaml: 定义了多个包的管理方式，支持 monorepo 结构。
  • tsconfig.base.json: TypeScript 的基础配置文件，定义了 TypeScript 编译器的全局配置。
  • tsconfig.build.json: TypeScript 的构建配置文件，定义了构建时的特定配置。
  • turbo.json: Turbo 配置文件，用于管理构建和开发流程，支持并行构建和缓存。
  • typedoc.json: TypeDoc 配置文件，用于生成项目的 API 文档。
  • vitest.config.ts: Vitest 配置文件，用于配置单元测试的运行环境。

配置文件作用

  • package.json: 管理项目的依赖和脚本，支持开发和构建流程。
  • pnpm-workspace.yaml: 支持 monorepo 结构，方便管理多个包。
  • tsconfig.base.json: 提供 TypeScript 编译器的全局配置，确保代码的一致性。
  • tsconfig.build.json: 提供构建时的特定配置，优化构建流程。
  • turbo.json: 优化构建和开发流程，支持并行构建和缓存，提高开发效率。
  • typedoc.json: 生成项目的 API 文档，方便开发者理解和使用。
  • vitest.config.ts: 配置单元测试的运行环境，确保代码质量。

通过以上配置文件，Substrate Connect 项目能够高效地进行开发、构建和测试，确保项目的稳定性和可维护性。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

网络标签：

相关问题