Publica tu proyecto de SubQuery

... 2022-8-15 About 5 min

# Publica tu proyecto de SubQuery

# Beneficios de alojar tu proyecto con SubQuery

  • Ejecutaremos tus proyectos de SubQuery en un servicio público de alto rendimiento, escalable y administrado
  • ¡Este servicio está siendo proporcionado a la comunidad gratis!
  • Puedes hacer públicos tus proyectos para que estén listados en el SubQuery Explorer (opens new window) y cualquier persona de todo el mundo puede verlos
  • Estamos integrados con GitHub, por lo que cualquiera en sus organizaciones de GitHub podrá ver proyectos de organización compartidos

# Crea tu primer proyecto en SubQuery Projects

# Alojamiento del código de proyecto

Hay dos maneras de alojar el código base de su proyecto SubQuery antes de publicarlo.

GitHub: El código base de tu proyecto debe estar en un repositorio público de GitHub

IPFS: El código base de su proyecto puede almacenarse en IPFS, puedes seguir nuestra guía de alojamiento IPFS para ver cómo publicar primero en IPFS

# Iniciar sesión en los proyectos de SubQuery

Antes de comenzar, asegúrese de que su proyecto SubQuery está en línea en un repositorio público de GitHub. El archivo schema.graphql debe estar en la raíz de su directorio.

Para crear tu primer proyecto, dirígete a project.subquery.network (opens new window). Necesitarás autenticarte con tu cuenta de GitHub para iniciar sesión.

En el primer inicio de sesión, se le pedirá que autorice SubQuery. Sólo necesitamos tu dirección de correo electrónico para identificar tu cuenta, y no utilizamos ningún otro dato de tu cuenta de GitHub por otras razones. En este paso, también puedes solicitar o conceder acceso a tu cuenta de la Organización de GitHub para que puedas publicar proyectos de SubQuery bajo tu Organización de GitHub en lugar de tu cuenta personal.

Revocar la aprobación de una cuenta de GitHub

SubQuery Projects es donde administras todos los proyectos alojados subidos a la plataforma SubQuery. Puede crear, eliminar e incluso actualizar proyectos desde esta aplicación.

Inicio de sesión de proyectos

Si tiene una cuenta de la organización de GitHub conectada, puedes usar el interruptor de la cabecera para cambiar entre tu cuenta personal y tu cuenta de la organización de GitHub. Los proyectos creados en una cuenta de la organización de GitHub son compartidos entre los miembros de esa organización de GitHub. Para conectar su cuenta de la Organización de GitHub, puede seguir los pasos aquí.

Cambiar entre cuentas de GitHub

# Cree su primer proyecto

Hay dos métodos para crear un proyecto en SubQuery Managed Service, puedes usar la interfaz de usuario o directamente a través de la herramienta de cli subql.

# Usando la interfaz de usuario

Empecemos haciendo clic en "Crear proyecto". Serás llevado al formulario de Proyecto Nuevo. Por favor, introduzca lo siguiente (puede cambiar esto en el futuro):

  • Cuenta de GitHub: Si tienes más de una cuenta de GitHub, selecciona la cuenta bajo la que se creará este proyecto. Los proyectos creados en una cuenta de la organización de GitHub son compartidos entre los miembros de esa organización de GitHub.
  • Nombre del proyecto
  • Subtítulo
  • Descripción
  • URL del repositorio de GitHub: Esta debe ser una URL válida de GitHub para un repositorio público que contiene su proyecto de SubQuery. El archivo schema.graphql debe estar en la raíz de su directorio (aprender más sobre la estructura de directorio).
  • Base de datos: Los clientes Premium pueden acceder a bases de datos dedicadas para albergar proyectos de subquery de producción. Si esto le interesa, puede ponerse en contacto con sales@subquery.network para activar esta configuración.
  • Fuente de despliegue Puede elegir tener el proyecto desplegado desde el repositorio de GitHub o desplegado alternativamente desde un CID IPFS, vea nuestra guía sobre alojamiento con IPFS.
  • Ocultar proyecto: Si se selecciona, esto ocultará el proyecto del explorador público de SubQuery. ¡Mantén esta opción sin seleccionar si quieres compartir tu SubQuery con la comunidad! Cree su primer proyecto

Crea tu proyecto y lo verás en la lista de proyectos de SubQuery. _¡Ya casi hemos llegado! Ahora solo necesitamos desplegar una version

Proyecto creado sin despliegue

# Usando la interfaz de usuario

También puede utilizar @subql/cli para publicar su proyecto en nuestro servicio administrado. Esto requiere:

// 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

# Desplegar tu primera versión

Hay dos métodos para desplegar una nueva versión de su proyecto en el Servicio Administrado de SubQuery, puedes usar la interfaz de usuario o directamente a través de la herramienta de cli subql.

# Usando la interfaz de usuario

Al crear un proyecto configurará el comportamiento de visualización del proyecto, debe desplegar una versión antes de que se ponga en marcha. Desplegar una versión activa una nueva operación de indexación de SubQuery para iniciar, y configurar el servicio de consultas requerido para comenzar a aceptar solicitudes GraphQL. También puede desplegar nuevas versiones a proyectos existentes aquí.

Con su nuevo proyecto, verá un botón Desplegar Nueva versión. Haga clic en esto y rellene la información requerida sobre el despliegue:

  • Rama: Desde GitHub, selecciona la rama del proyecto desde el que quieres desplegar
  • Commit Hash de la nueva versión: Desde GitHub seleccione el commit correcto del código base del proyecto SubQuery que desea desplegar
  • IPFS: Si se desplegan desde IPFS, pega el CID de despliegue IPFS (sin el CID principal ipfs://)
  • Anular los puntos finales de red y de diccionario: Aquí puedes sobreescribir los puntos finales en el manifiesto de tu proyecto
  • Versión del indexador: Esta es la versión del servicio de nodos de SubQuery en la que desea ejecutar esta SubQuery. Ver @subql/node (opens new window)
  • Versión de consulta: Esta es la versión del servicio de consulta de SubQuery en la que desea ejecutar esta SubQuery. Ver @subql/query (opens new window)

Desplegar tu primer proyecto

Si se implementa con éxito, verás que el indexador empieza a funcionar e informa de los avances en la indexación de la cadena actual. Este proceso puede llevar tiempo hasta que llegue al 100%.

# Usando la interfaz de usuario

También puede utilizar @subql/cli para crear un nuevo despliegue de su proyecto en nuestro servicio administrado. Esto requiere:

// 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

# Siguiente paso - Conecta a tu proyecto

Una vez que el despliegue se ha completado correctamente y nuestros nodos han indexado sus datos de la cadena, podrás conectarte a tu proyecto a través del punto final de la Consulta mostrada en GraphQL.

Proyecto en despliegue y sincronización

Alternativamente, puedes hacer clic en los tres puntos al lado del título de tu proyecto, y verlo en SubQuery Explorer. Allí puedes usar el playground del navegador para empezar. lee más sobre cómo usar nuestro explorador aquí.

Proyectos en el Explorador de SubQuery

# Añadir cuenta de la organización de GitHub a SubQuery Projects

Es común publicar su proyecto SubQuery bajo el nombre de su cuenta de la Organización de GitHub en lugar de su cuenta personal de GitHub. En cualquier momento puede cambiar su cuenta seleccionada en SubQuery Proyects (opens new window) usando el switcher de cuenta.

Cambiar entre cuentas de GitHub

Si no puede ver su cuenta de la organización de GitHub listada en el switcher, puede que necesite conceder acceso a SubQuery para su Organización de GitHub (o solicitarlo a un administrador). Para hacer esto, primero necesita revocar los permisos de su cuenta de GitHub a la aplicación de SubQuery. Para hacer esto, inicia sesión en la configuración de tu cuenta en GitHub, ve a Aplicaciones, y en la pestaña Aplicaciones OAuth Authorized Apps, revocar SubQuery - puedes seguir los pasos exactos aquí (opens new window). No te preocupes, esto no eliminará tu proyecto de SubQuery y no perderás ningún dato.

Revocar acceso a la cuenta de GitHub

Una vez que haya revocado el acceso, cierre la sesión de SubQuery Proyects (opens new window) e inicie sesión de nuevo. Debe ser redirigido a una página titulada Autorizar subconsulta donde puede solicitar o conceder acceso a SubQuery a su cuenta de la Organización de GitHub. Si no tienes permisos de administración, debes solicitar a un administrador que lo active.

Revocar la aprobación de una cuenta de GitHub

Una vez que esta solicitud ha sido aprobada por su administrador (o si eres capaz de concederlo tu mismo), verás la cuenta correcta de la Organizacion en Github en el cambiador de cuenta.

Last update: August 15, 2022 23:43