Etherface 项目安装与使用教程

Etherface 项目安装与使用教程

etherface Ethereum Signature Database 项目地址: https://gitcode.com/gh_mirrors/et/etherface

1. 项目的目录结构及介绍

Etherface 项目的目录结构如下：

etherface/
├── etherface-lib/
├── etherface-rest/
├── etherface-ui/
├── migrations/
├── res/
├── signature-dump/
├── sql/
│   └── bigquery/
├── env-EXAMPLE
├── gitignore
├── Cargo.toml
├── LICENCE.md
├── README.md
├── diesel.toml
├── docker-compose.yml
└── rustfmt.toml

目录结构介绍

• etherface/: 包含 Fetcher 和 Scraper 模块。
• etherface-lib/: 包含库特定的模块，如 API 客户端和数据库处理程序。
• etherface-rest/: 包含 REST API。
• etherface-ui/: 包含 NextJS 网页应用。
• migrations/: 包含数据库迁移文件。
• res/: 包含资源文件。
• signature-dump/: 包含签名数据。
• sql/bigquery/: 包含 BigQuery 相关的 SQL 文件。
• env-EXAMPLE: 环境变量示例文件。
• gitignore: Git 忽略文件。
• Cargo.toml: Rust 项目的配置文件。
• LICENCE.md: 项目许可证文件。
• README.md: 项目说明文件。
• diesel.toml: Diesel ORM 配置文件。
• docker-compose.yml: Docker 配置文件。
• rustfmt.toml: Rust 代码格式化配置文件。

2. 项目的启动文件介绍

启动 Etherface REST API

在 etherface/etherface-rest 目录下执行以下命令启动 REST API：

cargo r --release --bin etherface-rest

启动 Etherface UI

在 etherface/etherface-ui 目录下执行以下命令启动 NextJS 网页应用：

npm install
npm run dev

3. 项目的配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的配置文件，定义了项目的依赖、构建选项和其他元数据。

diesel.toml

diesel.toml 是 Diesel ORM 的配置文件，用于配置数据库连接和迁移设置。

docker-compose.yml

docker-compose.yml 是 Docker 配置文件，用于定义和运行多个 Docker 容器。

env-EXAMPLE

env-EXAMPLE 是环境变量示例文件，包含了项目运行所需的环境变量配置。

rustfmt.toml

rustfmt.toml 是 Rust 代码格式化工具的配置文件，用于定义代码格式化的规则。

通过以上步骤，您可以成功安装并启动 Etherface 项目，并了解其目录结构和配置文件的作用。

etherface Ethereum Signature Database 项目地址: https://gitcode.com/gh_mirrors/et/etherface