Augur项目安装与使用教程
1. 项目的目录结构及介绍
Augur项目的目录结构如下:
augur/
├── azure-templates/ # Azure部署模板
├── docs/ # 项目文档
├── infra/ # 基础设施相关文件
├── packages/ # 项目依赖包
├── scripts/ # 脚本文件
├── support/ # 支持文件
├── .dockerignore # Docker忽略文件
├── .editorconfig # 编辑器配置文件
├── .gitbook.yaml # Gitbook配置文件
├── .gitignore # Git忽略文件
├── .mergify.yml # Mergify配置文件
├── .nvmrc # Node版本管理文件
├── CODE_OF_CONDUCT.md # 行为准则
├── LICENSE # 许可证文件
├── Makefile # Makefile文件
├── README.md # 项目说明文件
├── SUMMARY.md # 项目摘要
├── azure-pipelines.yml # Azure管道配置文件
├── debugging.md # 调试指南
├── issues-workflow.md # 问题工作流
├── jest.config.js # Jest配置文件
├── lerna.json # Lerna配置文件
├── package.json # 项目配置文件
├── peek.yaml # Peek配置文件
├── prettier.config.js # Prettier配置文件
├── renovate.json # Renovate配置文件
├── setup_tmux.sh # Tmux配置脚本
├── tsconfig-base.json # TypeScript基础配置文件
├── tsconfig.json # TypeScript配置文件
├── tsconfig.release.json # TypeScript发布配置文件
├── tslint.json # TSLint配置文件
└── yarn.lock # Yarn锁定文件
目录详细介绍
- azure-templates/: 包含用于Azure部署的模板文件。
- docs/: 包含项目的相关文档。
- infra/: 包含基础设施相关的配置和脚本。
- packages/: 包含项目的依赖包。
- scripts/: 包含用于项目管理和构建的脚本文件。
- support/: 包含支持文件,如Docker配置等。
- .dockerignore: 指定Docker构建时需要忽略的文件和目录。
- .editorconfig: 用于统一代码风格的编辑器配置文件。
- .gitbook.yaml: Gitbook的配置文件。
- .gitignore: 指定Git版本控制时需要忽略的文件和目录。
- .mergify.yml: Mergify的配置文件,用于自动合并PR。
- .nvmrc: 指定项目所需的Node.js版本。
- CODE_OF_CONDUCT.md: 项目的行为准则。
- LICENSE: 项目的许可证文件。
- Makefile: 包含用于构建和测试项目的Make命令。
- README.md: 项目的基本介绍和使用说明。
- SUMMARY.md: 项目的摘要文件。
- azure-pipelines.yml: Azure DevOps的CI/CD配置文件。
- debugging.md: 包含调试项目的相关指南。
- issues-workflow.md: 描述问题处理的工作流。
- jest.config.js: Jest测试框架的配置文件。
- lerna.json: Lerna的配置文件,用于管理多包仓库。
- package.json: 项目的配置文件,包含依赖和脚本等信息。
- peek.yaml: Peek工具的配置文件。
- prettier.config.js: Prettier代码格式化工具的配置文件。
- renovate.json: Renovate的配置文件,用于自动更新依赖。
- setup_tmux.sh: 用于配置Tmux环境的脚本。
- tsconfig-base.json: TypeScript的基础配置文件。
- tsconfig.json: TypeScript的配置文件。
- tsconfig.release.json: TypeScript发布版本的配置文件。
- tslint.json: TSLint代码风格检查工具的配置文件。
- yarn.lock: Yarn的锁定文件,确保依赖版本一致。
2. 项目的启动文件介绍
项目的启动文件主要是通过Makefile
和package.json
中的脚本进行管理。
Makefile
Makefile
中定义了以下常用的命令:
- make build-typescript: 构建所有TypeScript代码(不包括UI和合约)。
- make watch-typescript: 持续监听并构建TypeScript代码(不包括UI和合约)。
- make build-ui: 构建UI代码。
- **make watch