Skip to content

Latest commit

 

History

History
182 lines (120 loc) · 5 KB

README.md

File metadata and controls

182 lines (120 loc) · 5 KB
Raw

Fuel-Explorer-Chinese

Fuel浏览器中文文档

安装依赖

安装所需的依赖项：

1. 安装 Node.js

  • 下载并安装 Node.js v20.11.0 或最新稳定版。

  • 我们建议使用 nvm（Node Version Manager） 来安装 Node.js。

    # 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

# 载入 nvm
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

# 安装指定版本的 Node.js
nvm install 20.11.0

# 使用指定版本的 Node.js
nvm use 20.11.0

2. 安装 PNPM

3. 安装 Docker

  • 下载并安装 Docker v25.0.3 或最新稳定版。

  • 下载并安装 Docker Compose v2.24.6 或最新稳定版。

    # 安装 Docker（示例命令，具体操作请参考官方文档）
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh

# 安装 Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/v2.24.6/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

⚠️注意：如果你是在中国大陆的开发者，可能会遇到无法连接docker镜像的情况，请自行解决网络问题

4. 安装 Rust

  • 下载并安装 Rust v1.76.0 或最新稳定版。

    # 安装 Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# 配置环境变量
source $HOME/.cargo/env

5. 安装 Forc

这样，你就完成了所有依赖项的安装，可以开始本地运行项目了。请按照后续步骤继续进行项目的设置和运行。

运行项目

📚 1. 获取仓库

  1. 访问 Fuel Explorer 仓库并fork该项目。
  2. 然后将fork后的副本克隆到本地机器上并开始工作。
git clone https://github.com/FuelLabs/fuel-explorer
cd fuel-explorer

📦 2. 安装依赖

pnpm install

📒 3. 运行本地节点

此命令将启动基本的开发服务：

  • L1 本地节点（处理以太坊区块链）；
  • Fuel 本地节点（处理L2链）；
  • Postgres 数据库（我们用来索引数据）；
pnpm node:start

你可以在 docker-compose.yml 文件中查看详情。

💻 4. 运行Web应用

现在你已经启动了本地节点，可以开始前端开发了。

  1. 在 packages/app-explorer 目录下基于提供的示例创建 .env 文件
cp packages/app-explorer/.env.example packages/app-explorer/.env
  1. 使用以下命令启动前端：
pnpm dev

运行该命令后，你可以在浏览器中打开 http://localhost:3000 查看 explorer 是否正常运行。

🧪 运行E2E测试

  1. 使用以下命令安装 Playwright 及其依赖项，包括 Chromium
pnpm exec playwright install --with-deps chromium
  1. 在 packages/graphql 目录下基于提供的示例创建 .env 文件
cp packages/graphql/.env.example packages/graphql/.env
  1. 启动本地节点服务器
pnpm node:start
  1. 最后，可以使用以下命令运行E2E测试：
pnpm test:e2e

🧰 有用的脚本

为了让开发更方便，我们在 package.json 中添加了许多有用的脚本。 以下是开发过程中最常用的一些脚本：

pnpm <command name>
脚本 描述
dev 运行开发服务器（仅前端）
node:start 使用 fuel-core 和 faucet API 运行本地网络。
node:stop 停止所有容器但不删除数据
node:clean 停止并删除本地运行的所有开发容器
node:restart 重启所有容器但不删除数据
test:e2e 运行E2E测试
ts:check 运行TypeScript编译器

其他脚本可以在 package.json 中找到。

参考资料

FuelLabs/fuel-explorer