Опублікуйте проект SubQuery

... 2022-8-11 Приблизно 3 хв

# Опублікуйте проект SubQuery

# Переваги розміщення вашого проекту за допомогою SubQuery

  • Ми будемо запускати ваші проекти SubQuery для вас у високопродуктивній, масштабованій та керованій державній службі
  • Ця послуга надається громаді безкоштовно!
  • Ви можете оприлюднити свої проекти, щоб вони були вказані в SubQuery Explorer (opens new window), і кожен у всьому світі може їх переглянути
  • Ми інтегровані з GitHub, тому кожен, хто з ваших організацій GitHub, зможе переглянути спільні організаційні проекти.

# Створіть свій перший проект у SubQuery Projects

# Хостинг проекту Codebase

Є два способи розміщення кодової бази проекту SubQuery перед публікацією.

GitHub: кодова база вашого проекту має бути у загальнодоступному сховищі GitHub

IPFS: кодову базу вашого проекту можна зберігати в IPFS. Ви можете дотримуватись нашого посібника з хостингу IPFS, щоб дізнатися, як першу опублікувати в IPFS

# Увійдіть до SubQuery Projects

Перш ніж почати, переконайтеся, що ваша кодова база проекту SubQuery знаходиться в режимі онлайн у загальнодоступному репозиторії GitHub або на IPFS. Файл schema.graphql має бути в корені вашого каталогу.

Щоб створити свій перший проект, перейдіть до project.subquery.network (opens new window). Щоб увійти, вам потрібно буде пройти автентифікацію за допомогою свого облікового запису GitHub.

Під час першого входу вам буде запропоновано авторизувати SubQuery. Нам потрібна лише ваша адреса електронної пошти, щоб ідентифікувати ваш обліковий запис, і ми не використовуємо будь-які інші дані з вашого облікового запису GitHub з будь-яких інших причин. На цьому кроці ви також можете запросити або надати доступ до свого облікового запису організації GitHub, щоб ви могли публікувати проекти SubQuery у своїй організації GitHub замість свого особистого облікового запису.

Скасувати схвалення облікового запису GitHub

SubQuery Projects — це місце, де ви керуєте всіма своїми розміщеними проектами, завантаженими на платформу SubQuery. За допомогою цієї програми можна створювати, видаляти та навіть оновлювати проекти.

Вхід до проектів

Якщо у вас підключені облікові записи організації GitHub, ви можете використовувати перемикач у заголовку, щоб перемикатися між вашим особистим обліковим записом і обліковим записом організації GitHub. Проекти, створені в обліковому записі організації GitHub, спільно використовують члени цієї організації GitHub. Щоб підключити свій обліковий запис організації GitHub, ви можете виконати вказівки тут.

Перемикайтеся між обліковими записами GitHub

# Створіть свій перший проект

There are two methods to create a project in the SubQuery Managed Service, you can use the UI or directly via the subql cli tool.

# Using the UI

Let's start by clicking on "Create Project". You'll be taken to the New Project form. Please enter the following (you can change this in the future):

  • ** Обліковий запис GitHub: ** Якщо у вас є більше одного облікового запису GitHub, виберіть, в якому обліковому записі буде створено цей проект. Проекти, створені на рахунку організації GitHub, поділяються між членами цієї організації.
  • Назва проєкту
  • Підзаголовок
  • Описання
  • ** itHub Repository URL: ** Це має бути дійсною URL-адресою GitHub для публічного сховища, яке має ваш проект SubQuery. Файл schema.graphql повинен бути в корені вашого каталогу ( дізнатися більше про структуру каталогу ).
  • База даних: Клієнти преміум-класу можуть отримати доступ до виділених баз даних для розміщення виробничих проектів SubQuery. Якщо вас це цікавить, ви можете зв’язатися з sales@subquery.network, щоб увімкнути це налаштування.
  • Джерело розгортання: Ви можете розгорнути проект із репозитарію GitHub або розгорнути з IPFS CID, дивіться наш посібник щодо хостингу за допомогою IPFS.
  • Приховати проект: Якщо вибрано, це приховає проект з громадського засобу обробки підкадрів. Зберігайте це необрано, якщо ви хочете поділитися підробкою із спільнотою! Створіть свій перший проект

Create your project and you'll see it on your SubQuery Project's list. We're almost there! We just need to deploy a new version of it.

Created Project with no deployment

# Using the CLI

You can also use @subql/cli to publish your project to our managed service. This requires:

// Creating a project using the CLI
$ subql project:create-project

// OR using non-interactive, it will prompt you if the required fields are missing
$ subql project:create-project
    --apiVersion=apiVersion      Api version is default to 2
    --description=description    Enter description
    --gitRepo=gitRepo            Enter git repository
    --org=org                    Enter organization name
    --project_name=project_name  Enter project name
1
2
3
4
5
6
7
8
9
10

# Deploy your First Version

There are two methods to deploy a new version of your project to the SubQuery Managed Service, you can use the UI or directly via the subql cli tool.

# Using the UI

While creating a project will setup the display behaviour of the project, you must deploy a version of it before it becomes operational. Deploying a version triggers a new SubQuery indexing operation to start, and sets up the required query service to start accepting GraphQL requests. You can also deploy new versions to existing projects here.

With your new project, you'll see a Deploy New Version button. Click this, and fill in the required information about the deployment:

  • Branch: From GitHub, select the branch of the project that you want to deploy from
  • Commit Hash: From GitHub, select the specific commit of the version of your SubQuery project codebase that you want deployed
  • IPFS: If deploying from IPFS, paste you IPFS deployment CID (without the leading ipfs://)
  • Override Network and Dictionary Endpoints: You can override the endpoints in your project manifest here
  • Indexer Version: This is the version of SubQuery's node service that you want to run this SubQuery on. See @subql/node (opens new window)
  • Query Version: This is the version of SubQuery's query service that you want to run this SubQuery on. See @subql/query (opens new window)

Deploy your first Project

If deployed successfully, you'll see the indexer start working and report back progress on indexing the current chain. This process may take time until it reaches 100%.

# Using the CLI

You can also use @subql/cli to create a new deployment of your project to our managed service. This requires:

// Deploy using the CLI
$ suqbl deployment:deploy

// OR Deploy using non-interactive CLI
$ suqbl deployment:deploy
  --dict=dict                      Enter Dictionary Endpoint
  --endpoint=endpoint              Enter Network Endpoint
  --indexerVersion=indexerVersion  Enter indexer-version
  --ipfsCID=ipfsCID                Enter IPFS CID
  --org=org                        Enter Organization Name
  --project_name=project_name      Enter Project Name
  --queryVersion=queryVersion      Enter Query-version
  --type=type                      Enter deployment type e.g. primary or stage
1
2
3
4
5
6
7
8
9
10
11
12
13

# Наступні етапи - Підключіться до вашого проекту

Після того, як ваше розгортання успішно завершиться і наші вузли індексують ваші дані з ланцюга, ви зможете підключитися до вашого проекту через відображену кінцеву точку GraphQL Query.

Проект розгортається та синхронізується

Крім того, ви можете натиснути на три точки поруч із заголовком проекту та переглянути його на SubQuery Explorer. There you can use the in-browser playground to get started - read more about how to use our Explorer here.

Projects in SubQuery Explorer

# Додайте обліковий запис організації GitHub до проектів SubQuery

It is common to publish your SubQuery project under the name of your GitHub Organization account rather than your personal GitHub account. At any point your can change your currently selected account on SubQuery Projects (opens new window) using the account switcher.

Перемикайтеся між обліковими записами GitHub

If you can't see your GitHub Organization account listed in the switcher, the you may need to grant access to SubQuery for your GitHub Organization (or request it from an administrator). To do this, you first need to revoke permissions from your GitHub account to the SubQuery Application. To do this, login to your account settings in GitHub, go to Applications, and under the Authorized OAuth Apps tab, revoke SubQuery - you can follow the exact steps here (opens new window). Don't worry, this will not delete your SubQuery project and you will not lose any data.

Revoke access to GitHub account

Once you have revoked access, log out of SubQuery Projects (opens new window) and log back in again. You should be redirected to a page titled Authorize SubQuery where you can request or grant SubQuery access to your GitHub Organization account. If you don't have admin permissions, you must make a request for an adminstrator to enable this for you.

Скасувати схвалення облікового запису GitHub

Once this request has been approved by your administrator (or if are able to grant it youself), you will see the correct GitHub Organization account in the account switcher.

Останнє оновлення: August 11, 2022 08:36