10101 项目教程
1. 项目的目录结构及介绍
10101 项目的目录结构如下:
10101/
├── cargo/
├── cargo/
├── github/
├── coordinator/
├── crates/
├── data/
├── docs/
├── logos/
├── mobile/
├── scripts/
├── services/
├── utils/
├── webapp/
├── env.sample
├── esplora.env
├── .gitignore
├── CONTRIBUTING.md
├── Cargo.lock
├── Cargo.toml
├── DEVELOPMENT.md
├── LICENSE
├── README.md
├── RELEASE.md
├── SECURITY.md
├── check_compatibility.sh
├── clippy.toml
├── diesel.toml
├── docker-compose.yml
├── dprint.json
├── justfile
├── rust-toolchain.toml
├── rustfmt.toml
目录介绍
cargo/
: Cargo 相关的文件。github/
: GitHub 相关的文件。coordinator/
: 协调器相关的代码。crates/
: Rust 的 crate 文件。data/
: 数据文件。docs/
: 文档文件。logos/
: 项目 logo 文件。mobile/
: 移动端应用相关文件。scripts/
: 脚本文件。services/
: 服务相关文件。utils/
: 工具类文件。webapp/
: Web 应用相关文件。env.sample
: 环境变量示例文件。esplora.env
: Esplora 环境变量文件。.gitignore
: Git 忽略文件。CONTRIBUTING.md
: 贡献指南。Cargo.lock
: Cargo 锁定文件。Cargo.toml
: Cargo 配置文件。DEVELOPMENT.md
: 开发指南。LICENSE
: 项目许可证。README.md
: 项目介绍文件。RELEASE.md
: 发布指南。SECURITY.md
: 安全指南。check_compatibility.sh
: 兼容性检查脚本。clippy.toml
: Clippy 配置文件。diesel.toml
: Diesel 配置文件。docker-compose.yml
: Docker Compose 配置文件。dprint.json
: Dprint 配置文件。justfile
: Justfile 配置文件。rust-toolchain.toml
: Rust 工具链配置文件。rustfmt.toml
: Rustfmt 配置文件。
2. 项目的启动文件介绍
启动文件
justfile
: 这是一个 Justfile 文件,用于定义项目的构建和启动命令。通过运行just all
命令可以启动所有必要的服务,包括本地的桌面应用。
启动命令
just all
: 启动所有必要的服务,包括本地的桌面应用。just all-ios
: 启动所有必要的服务,包括 iOS 模拟器上的应用。just all-android
: 启动所有必要的服务,包括 Android 模拟器上的应用。
3. 项目的配置文件介绍
配置文件
Cargo.toml
: 这是 Rust 项目的配置文件,定义了项目的依赖、构建选项等。docker-compose.yml
: Docker Compose 配置文件,定义了 Docker 容器的配置和启动方式。diesel.toml
: Diesel 配置文件,用于配置数据库连接。rust-toolchain.toml
: Rust 工具链配置文件,定义了项目使用的 Rust 工具链版本。rustfmt.toml
: Rustfmt 配置文件,定义了代码格式化的规则。clippy.toml
: Clippy 配置文件,定义了代码检查的规则。dprint.json
: Dprint 配置文件,定义了代码格式化的规则。
环境变量文件
env.sample
: 环境变量示例文件,包含了项目运行所需的环境变量。esplora.env
: Esplora 环境变量文件,用于配置 Esplora 服务。
通过这些配置文件,可以灵活地配置和启动 10101 项目。