Coinbase OnchainKit 开发者指南

Coinbase OnchainKit 开发者指南

onchainkit OnchainKit is a collection of tools to build world-class onchain apps with CSS, React, and typescript. 项目地址: https://gitcode.com/gh_mirrors/on/onchainkit

1. 项目目录结构及介绍

OnchainKit 是一个由 Coinbase 开发的开源项目，旨在为开发者提供构建顶级链上应用程序所需的 React 组件和 TypeScript 实用工具。以下是项目的目录结构及其简要介绍：

onchainkit/
├── .changeset/              # 用于管理变更集的配置文件
├── .github/                 # GitHub 工作流程和配置文件
├── assets/                  # 静态资源文件夹
├── packages/                # 项目包目录，包含所有模块和组件
│   └── ...                  # 具体的包和子目录
├── .gitignore               # 指定 Git 忽略的文件和目录
├── .nvmrc                   # 指定 Node.js 版本的配置文件
├── .prettierignore          # 指定 Prettier 忽略的文件和目录
├── .prettierrc              # Prettier 配置文件
├── LICENSE.md               # MIT 许可证文件
├── README.md                # 项目自述文件
├── eslint.config.mjs        # ESLint 配置文件
├── package.json             # 项目包配置文件
├── pnpm-lock.yaml           # pnpm 锁文件
├── pnpm-workspace.yaml      # pnpm 工作空间配置文件
└── ...                      # 其他配置和脚本文件

2. 项目的启动文件介绍

OnchainKit 的启动通常涉及到 package.json 文件中定义的脚本。以下是一些主要的启动脚本：

• npm create onchain: 这个命令用于引导一个包含所有必需组件的示例链上应用程序。
• pnpm f:play dev:watch: 当你在组件上工作时，这个命令用于在监视模式下构建 OnchainKit 并启动 playground，以便查看你的组件。

在项目根目录下，通过以下命令可以查看所有可用的脚本：

pnpm run

3. 项目的配置文件介绍

OnchainKit 使用多种配置文件来管理和定制开发环境。以下是一些重要的配置文件：

• .gitignore: 这个文件用于指定 Git 应该忽略的文件和目录，以避免将不必要的文件提交到版本控制系统中。
• .nvmrc: 这个文件指定了项目应该使用的 Node.js 版本，确保所有开发者使用相同的版本。
• .prettierignore 和 .prettierrc: 这些文件用于配置 Prettier，一个代码格式化工具，以确保代码风格的一致性。
• eslint.config.mjs: ESLint 配置文件用于定义代码质量和风格的规则。

这些配置文件确保了项目的可维护性和一致性，有助于开发者在遵循最佳实践的同时工作。

onchainkit OnchainKit is a collection of tools to build world-class onchain apps with CSS, React, and typescript. 项目地址: https://gitcode.com/gh_mirrors/on/onchainkit