开源项目子扫描核心:subscan-essentials安装与使用指南
本指南旨在详细解释如何搭建与配置基于Subscan团队开发的subscan-essentials
项目,一个高精度的区块链浏览器框架。这个项目专为基于Substrate的区块链网络设计,提供开发者友好的界面和定制化的模块解析能力。
1. 项目目录结构及介绍
项目目录结构概览:
subscan-essentials/
├── cmd # 子命令执行入口,包括数据库和API服务启动脚本
│ ├── subscan # 主要的控制台应用程序
│ └── ...
├── configs # 配置文件夹,存放各种环境所需的配置
│ ├── config.yaml # 核心应用配置
│ ├── redis.toml # Redis配置
│ ├── mysql.toml # MySQL数据库配置
│ └── http.toml # HTTP服务器配置
├── src # 源代码文件夹,项目的核心逻辑所在
│ ├── ... # 包含业务逻辑、数据访问等模块
├── README_ZH.md # 中文说明文档
├── LICENCE # 许可证文件,遵循GPL-3.0协议
└── ...
- cmd: 包含用于启动不同服务的命令行工具。
- configs: 包含所有必要的配置文件,允许开发者自定义数据库连接、Redis设置以及HTTP服务端口等。
- src: 项目的主要代码库,实现探索器的功能逻辑。
2. 项目的启动文件介绍
2.1 数据库与后台服务启动
在cmd
目录下,关键的启动文件是与subscan
相关的脚本。为了运行项目,你需要首先确保Redis和MySQL已经启动。
-
启动数据库服务: 根据你的实际情况配置
configs
中的Redis(redis.toml
)和MySQL(mysql.toml
)配置文件,然后直接管理这些服务的外部进程。 -
启动Substrate Daemon: 在
cmd/subscan
目录中执行start
命令来启动后端服务,确保数据库连接已正确设置。
2.2 API服务器启动
同样位于cmd/subscan
下的操作,通过特定命令可以管理API服务器的启动和其他相关任务,具体命令需参照项目文档内的说明。
3. 项目的配置文件介绍
3.1 核心配置 (config.yaml
)
- 作用: 设置基础的应用行为,如插件支持、索引类型等。
- 示例: 自动加载的配置文件,通常覆盖默认值或添加特定的项目配置项。
3.2 Redis配置 (redis.toml
)
- 地址: 定义Redis服务器的位置和端口,默认为localhost:6379。
- 重要性: 对于缓存和消息队列至关重要。
3.3 MySQL配置 (mysql.toml
)
- 细节: 包括主机名、用户名、密码、数据库名的设置,用于存储区块链的索引数据。
- 默认值: 默认配置指向本地MySQL实例的默认设置。
3.4 HTTP配置 (http.toml
)
- 监听端口: 可以设定后端服务的HTTP监听地址和端口,便于客户端访问。
通过上述步骤和配置,开发者能够快速搭建并配置subscan-essentials
项目,进而开发出适应自身需求的区块链浏览器服务。记住在实际部署前仔细调整配置文件以符合生产环境需求。