Опубликовать ваш проект SubQuery

... 2022-5-22 Меньше 1 минуты

# Опубликовать ваш проект SubQuery

# Преимущества хостинга вашего проекта с SubQuery

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

# Создайте свой первый проект в разделе SubQuery Projects

# Хостинг кодовой базы проекта

Существует два способа размещения кодовой базы вашего проекта SubQuery перед публикацией.

GitHub: кодовая база вашего проекта должна находиться в публичном репозитории GitHub

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

# Вход в проекты SubQuery

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

Чтобы создать свой первый проект, зайдите в project.subquery.network (opens new window). Для входа в систему вам потребуется аутентификация с помощью учетной записи GitHub.

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

Отмена одобрения учетной записи GitHub

SubQuery Projects - это место, где вы управляете всеми своими проектами, загруженными на платформу SubQuery. Вы можете создавать, удалять и даже обновлять проекты из этого приложения.

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

Если у вас подключены аккаунты GitHub Organization, вы можете использовать переключатель в заголовке, чтобы переключаться между личным аккаунтом и аккаунтом GitHub Organization. Проекты, созданные в учетной записи GitHub Organization, распространяются между членами этой GitHub Organization. Для подключения учетной записи GitHub Organization вы можете последовать следующим шагам.

Переключение между учетными записями GitHub

# Создайте ваш первый проект

Начните с нажатия на "Создать проект". Вы попадете на форму "Новый проект". Пожалуйста, введите следующие данные (вы можете изменить их в будущем):

  • ** Учетная запись GitHub: ** Если у вас есть более одной учётной записи GitHub, выберите, под какой учётной записью будет создан этот проект. Проекты, созданные в учетной записи организации GitHub, совместно используются участниками в этой организации.
  • Название проекта
  • Тема
  • Описание
  • ** URL-адрес репозитория GitHub: ** Это должен быть действующий URL-адрес GitHub для общедоступного репозитория, в котором находится ваш проект SubQuery. Файл schema.graphql должен находиться в корне вашего каталога ( узнайте больше о структуре каталогов ).
  • ** База данных:** Премиум-клиенты могут получить доступ к выделенным базам данных для размещения производственных проектов SubQuery. Если это вас интересует, вы можете связаться с sales@subquery.network, чтобы включить эту настройку.
  • Источник развертывания: Вы можете выбрать развертывание проекта из репозитория GitHub или альтернативное развертывание из IPFS CID, см. наше руководство о хостинге с IPFS.
  • Скрыть проект: Это скроет ваш проект для публичного изучения. Не устанавливайте этот флажок, если хотите поделиться своим проектом с сообществом! Создайте свой первый проект

Создайте свой проект, и вы увидите его в списке SubQuery Project. _ Мы почти у цели! Нам просто нужно развернуть новую версию._

Созданный проект без развертывания

# Развертывание вашей первой версии

Хотя создание проекта настроит поведение проекта на экране, вы должны развернуть его версию, прежде чем он начнет работать. Развертывание версии запускает новую операцию индексирования SubQuery и устанавливает необходимую службу запросов, чтобы начать принимать запросы GraphQL. Здесь же можно развернуть новые версии в существующих проектах.

В новом проекте вы увидите кнопку Развернуть новую версию. Щелкните это и заполните необходимую информацию о развертывании:

  • ** Branch:** На GitHub выберите ветвь проекта, из которой вы хотите развернуть проект
  • Commit Hash: На GitHub выберите конкретный коммит той версии кодовой базы вашего проекта SubQuery, которую вы хотите развернуть.
  • IPFS: При развертывании из IPFS вставьте CID развертывания IPFS (без ведущего ipfs://).
  • Определение конечных точек сети и словаря: Вы можете переопределить конечные точки в манифесте вашего проекта здесь
  • Indexer Version: Это версия службы узла SubQuery, на которой вы хотите запустить этот SubQuery. Смотреть @subql/node (opens new window)
  • Query Version: Это версия службы запросов SubQuery, в которой вы хотите запустить этот SubQuery. Смотреть @subql/node (opens new window)

Разверните свой первый проект

При успешном развертывании вы увидите, как индексатор начинает работать и сообщает о ходе индексирования текущей цепочки. Этот процесс может занять некоторое время, пока он не достигнет 100%.

# Следующие шаги - подключитесь к вашему проекту

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

Проект развернут и синхронизирован

Альтернативно, вы можете кликнуть по трем точкам рядом с названием вашего проекта и просмотреть его в SubQuery Explorer. Там вы можете использовать внутрибраузерную игровую площадку для начала работы - читайте больше о том, как использовать наш Explorer здесь.

Проекты в SubQuery Эксплорере

# Добавить учетную запись организации GitHub в проекты подзапроса

Обычно проект SubQuery публикуется под именем вашей учетной записи GitHub Organization, а не вашей личной учетной записи GitHub. В любой момент вы можете изменить выбранную учетную запись на SubQuery Projects (opens new window) с помощью переключателя учетных записей.

Переключение между учетными записями GitHub

Если вы не видите учетную запись организации GitHub в списке переключателя, возможно, вам необходимо предоставить доступ к SubQuery для вашей организации GitHub (или запросить его у администратора). Для этого сначала нужно отозвать разрешения из учетной записи GitHub на приложение SubQuery. Для этого войдите в настройки вашей учетной записи на GitHub, перейдите в раздел Applications и на вкладке Authorized OAuth Apps отмените SubQuery - вы можете следовать инструкции здесь (opens new window). ** Не волнуйтесь, это не удалит ваш проект SubQuery, и вы не потеряете никаких данных.**

Отменить доступ к учетной записи GitHub

После отзыва доступа выйдите из SubQuery Projects (opens new window) и снова войдите в систему. Вы должны быть перенаправлены на страницу под названием Authorize SubQuery, где вы можете запросить или предоставить SubQuery доступ к вашей учетной записи GitHub Organization. Если у вас нет прав администратора, вы должны сделать запрос администратору, чтобы он включил это для вас.

Отмена одобрения учетной записи GitHub

Как только этот запрос будет одобрен вашим администратором (или если вы сами сможете его удовлетворить), вы увидите правильную учетную запись GitHub Organization в переключателе учетных записей.

Последнее обновление: May 22, 2022 06:06