Rooch 项目使用教程

1. 项目目录结构及介绍

Rooch 项目的目录结构如下：

rooch/
├── cargo/
├── github/
├── crates/
├── docker/
├── docs/website/
├── examples/
├── frameworks/
├── infra/
├── kube/
├── moveos/
├── scripts/
├── sdk/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── CONTRIBUTING_zh.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── SECURITY.md
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── prettier.config.js
├── rust-toolchain.toml
└── rustfmt.toml

目录介绍

• cargo/: 包含 Cargo 相关的配置文件。
• github/: 包含 GitHub 相关的配置文件。
• crates/: 包含 Rust 的 crate 文件。
• docker/: 包含 Docker 相关的配置文件。
• docs/website/: 包含项目文档和网站相关的文件。
• examples/: 包含项目的示例代码。
• frameworks/: 包含项目使用的框架文件。
• infra/: 包含基础设施相关的文件。
• kube/: 包含 Kubernetes 相关的配置文件。
• moveos/: 包含 MoveOS 相关的文件。
• scripts/: 包含项目的脚本文件。
• sdk/: 包含项目的 SDK 文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• CONTRIBUTING_zh.md: 项目贡献指南的中文版本。
• Cargo.lock: Cargo 的锁定文件。
• Cargo.toml: Cargo 的配置文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• SECURITY.md: 项目的安全指南。
• package.json: Node.js 项目的配置文件。
• pnpm-lock.yaml: pnpm 的锁定文件。
• pnpm-workspace.yaml: pnpm 的工作区配置文件。
• prettier.config.js: Prettier 的配置文件。
• rust-toolchain.toml: Rust 工具链的配置文件。
• rustfmt.toml: Rustfmt 的配置文件。

2. 项目启动文件介绍

Rooch 项目的启动文件主要是通过 cargo 命令来启动的。以下是启动项目的步骤：

1. 构建项目:

   cargo build
   

2. 初始化 Rooch 配置:

   rooch init
   

3. 启动本地服务器:

   rooch server start -n local
   

4. 调试信息:

   RUST_LOG=debug rooch server start
   

3. 项目配置文件介绍

Rooch 项目的主要配置文件包括：

• Cargo.toml: 这是 Rust 项目的配置文件，包含了项目的依赖、构建选项等信息。
• package.json: 这是 Node.js 项目的配置文件，包含了项目的依赖、脚本等信息。
• pnpm-workspace.yaml: 这是 pnpm 的工作区配置文件，用于管理多个包的依赖关系。
• rust-toolchain.toml: 这是 Rust 工具链的配置文件，用于指定 Rust 的版本和工具链。
• rustfmt.toml: 这是 Rustfmt 的配置文件，用于配置代码格式化规则。

这些配置文件共同作用，确保项目能够正确构建和运行。