快速入门指南

2021-11-24 大约 4 分钟

# 快速入门指南

在本快速入门指南中,我们将创建一个简单的入门项目,您可以将其用作开发您自己的 SubQuery 项目的框架。

在本指南的最后,您将拥有一个在 SubQuery 节点上运行的可工作 的 SubQuery 项目,该节点具有一个可以从中查询数据的 GraphQL 端点。

如果您还没有准备好,我们建议您熟悉SubQuery中所使用的 术语

# 准备工作

# 本地开发环境

# 安装 SubQuery CLI

使用 NPM 在终端上全局安装 SubQuery CLI:

# NPM
npm install -g @subql/cli
1
2

请注意我们不鼓励使用 yarn global ,因为它的依赖性管理很差,这可能会导致错误。

然后,您可以运行帮助以查看 CLI 提供的可用命令和用法。

subql help
1

# 初始化 Starter SubQuery 项目

在您要创建 SubQuery 项目的目录中,只需将PROJECT_NAME 替换为您自己的项目名称并运行命令:

subql init --starter PROJECT_NAME
1

在初始化 SubQuery project 时,您会被问到一些问题:

  • Git 存储库(可选):提供指向此 SubQuery 项目的,并将在其中托管的存储库的 Git URL(当托管在 SubQuery Explorer 中时)
  • RPC 端点(必填):提供一个 wss URL给一个正在运行的 RPC 端点,该端点将默认用于此项目。 您可以快速访问不同的 Polkadot 网络的公共端点,甚至可以使用 OnFinality (opens new window) 或仅使用默认的 Polkadot 端点创建您自己的专用节点。
  • 作者(必填):在此处输入此 SubQuery 项目的所有者
  • 描述(可选):您可以提供一个简短的段落介绍您的项目,描述它包含哪些数据以及用户可以做些什么。
  • 版本 (必填):输入一个自定义版本号或使用默认版本(1.0.0)
  • 许可证(必填):提供此项目的软件许可或接受默认设置(Apache-2.0)

在初始化过程完成后,您应该看到目录内创建了一个项目名称的文件夹。 此目录的内容应该与 Directory Structure 中列出的内容完全相同。

最后,在项目目录下,运行以下命令来安装新项目的依赖关系。

上次编辑于: 2021年11月24日 02:27