首页
/ Aragon Apps 开源项目安装与使用指南

Aragon Apps 开源项目安装与使用指南

2024-09-24 12:21:43作者:邓越浪Henry

项目概述

Aragon Apps 是由 Aragon 核心开发者团队编写的智能合约与Web应用套件,适用于构建去中心化自治组织(DAOs)。这个开源项目采用Yarn工作spaces和Lerna来管理各个独立的应用程序,使得它们可以协同工作,并且每个应用都配有一个前端界面设计用于通过Aragon客户端进行安装和使用。

目录结构及介绍

.
├── apps                  # 存放所有应用程序的主目录
│   ├── agreement         # 管理组织通过主观规则的应用
│   ├── agent             # 持有资产并代表Aragon组织执行动作的应用
│   ├── finance           # 处理支付和预算管理的应用
│   ├── tokens            # 管理组织代币供应和分布的应用
│   └── ...               # 其它如Voting、Vault等应用
├── shared                # 共享代码库,供多个应用复用
├── travis.yml            # Travis CI 配置文件
├── CONTRIBUTING.md       # 贡献者指南
├── LICENSE               # 许可证文件,采用AGPL-3.0
└── README.md             # 主要的项目说明文件
  • apps: 包含所有独立的Aragon应用。
  • shared: 该目录存放着可以在不同应用间共享的组件或逻辑。
  • travis.yml: 用于持续集成(CI)的配置文件。
  • CONTRIBUTING.md: 为希望贡献到项目的人提供的贡献指导。
  • LICENSE: 记载了项目的许可证信息。
  • README.md: 提供项目概览和快速入门指南。

启动文件介绍

在Aragon Apps中,并没有特定提到一个“启动文件”,但通常来说,通过以下步骤初始化和运行项目:

  1. 进入项目根目录后,运行 yarn 命令,这将初始化所有的工作空间并安装依赖,实现共享依赖项的hoisting(提升)至根目录下的node_modules

  2. 若要专注于开发某个特定应用,你可以进入该应用的目录(例如,cd apps/voting),然后使用 yarn install --focus 来仅安装该应用的依赖。

对于前端的启动,你需要进入应用内的app/子目录,并使用 yarn start 开始前端的开发服务器,比如对voting应用:

cd apps/voting/app/
yarn start

项目配置文件介绍

  • .gitignore: 定义不应被版本控制的文件类型或文件夹。
  • lerna.json: 使用Lerna时的配置文件,描述如何管理和发布多包项目。
  • package.json: 包含了项目的元数据,如依赖项、脚本命令等。
  • travis.yml: 之前已提及,定义了自动化测试、部署等CI/CD流程。

虽然具体配置细节未详细列出,这些文件构成了项目的基础配置体系,其中package.json尤其重要,因为它包含了项目构建、测试和部署相关的脚本指令。

注意:

在实际操作中,深入了解每个特定应用内部的结构以及特定配置文件(如各应用可能有自己的package.json和特定配置文件)也是很重要的。此文档提供了一个高层次的视角,具体深入学习还需参考项目中的文档和注释。

登录后查看全文
热门项目推荐