Hola Mundo (localhost & Docker)
Hola Mundo (localhost & Docker)
Bienvenido a este inicio rápido de SubQuery Hola Mundo. El inicio rápido apunta a mostrarle cómo se ejecuta el proyecto inicial predeterminado en Docker en unos pocos pasos.
Objetivos de aprendizaje
Al final de este inicio rápido, deberías:
- entender los requisitos requeridos
- entender los comandos básicos comunes
- ser capaz de navegar a localhost:3000 y ver el patio de juegos
- ejecuta una simple consulta para obtener la altura del bloque del mainnet Polkadot
Audiencia intencionada
Esta guía está dirigida a nuevos desarrolladores que tienen cierta experiencia de desarrollo y están interesados en aprender más sobre SubQuery.
Guía en vídeo
Pre-requisitos
Necesitarás:
- gestor de paquetes yarn o npm
- SubQuery CLI (
@subql/cli) - Docker
Puede ejecutar los siguientes comandos en un terminal para ver si ya tiene alguno de estos requisitos previos.
yarn -v (o npm -v)
subql -v
docker -v
Para usuarios más avanzados, copie y pegue lo siguiente:
echo -e "My yarn version is:" `yarn -v` "\nMy subql version is:" `subql -v` "\nMy docker version is:" `docker -v`
Esto debería regresar: (para usuarios de npm, reemplace yarn con npm)
Mi versión de yarn es: 1.22.10
Mi versión de subql es: @subql/cli/0.9.3 darwin-x64 node-v16.3.0
Mi versión de docker es: Docker versión 20.10.5, compilar 55c4c88
Si usted consigue lo anterior, entonces tiene luz verde para continuar. Si no, sigue estos enlaces para instalarlos:
1. Paso 1: iniciar el proyecto
El primer paso al comenzar con SubQuery es ejecutar el comando subql init. Inicialicemos un proyecto inicial con el nombre subqlHelloWorld. Tenga en cuenta que sólo el autor es obligatorio. Todo lo demás queda vacío.
> subql init subqlHelloWorld
? ¿Seleccionar una red Polkadot
? Seleccione un proyecto de plantilla subql-starter Starter proyecto para subconsulta
Proyecto de Clonación... hecho
RPC endpoint: [wss://polkadot. pi.onfinality.io/public-ws]:
Repositorio Git [https://github.com/subquery/subql-starter]:
Obteniendo la genesis de red hash.. done
Autor [Ian He & Jay Ji]:
Descripción [Este proyecto puede ser utilizado como un inicio de...]:
Versión [0.0.4]:
Licencia [MIT]:
proyecto de preparación... hecho
subqlHelloWorld está listo
No olvides cambiar a este nuevo directorio.
cd subqlHelloWorld
2. Paso 2: Instalar dependencias
Ahora haga una instalación de yarn o node para instalar las distintas dependencias.
::: code-tabs @tab:active yarn shell yarn build @tab npm bash npm run-script build :::
An example of yarn build
# Yarn yarn install # NPM npm install
```
```shell
yarn install
yarn install v1.22.10
info No lockfile found.
[1/4] 🔍 Resolving packages...
[2/4] 🚚 Fetching packages...
[3/4] 🔗 Linking dependencies...
[4/4] 🔨 Building fresh packages...
success Saved lockfile.
✨ Done in 31.84s.
3. Step 3: Generador de codigo
Ahora ejecuta yarn codegen para generar Typescript desde el esquema GraphQL.
# Yarn yarn codegen
# NPM npm run-script codegen
> yarn codegen
yarn run v1.22.10
$ ./node_modules/.bin/subql codegen
===============================
---------Subql Codegen---------
===============================
* Schema StarterEntity generated !
* Models index generated !
* Types index generated !
✨ Done in 1.02s
yarn codegen
yarn run v1.22.10
$ ./node_modules/.bin/subql codegen
===============================
---------Subql Codegen---------
===============================
* Schema StarterEntity generated !
* Models index generated !
* Types index generated !
✨ Done in 1.02s.
* Tipo de índice generado!
* Tipo de índice generado!
* Tipo de índice generado!
✨ Hecho en 0.06s. ```
✨ Hecho en 1.02s.
```
**Advertencia** Cuando se hacen cambios en el archivo de schema, por favor recuerde volver a ejecutar `yarn codegen` para regenerar el directorio de tipos.
## 4. Paso 4: Contruye el codigo
El siguiente paso es construir el código con `yarn build`.
`# Yarn yarn build # NPM npm run-script build`
```shell
> yarn build
yarn run v1.22.10
$ tsc -b
✨ Done in 5.68s.
```
## 5. Ejecutar Docker
El uso de Docker le permite ejecutar este ejemplo muy rápidamente, ya que toda la infraestructura necesaria se puede proporcionar dentro de la imagen Docker. Ejecuta `docker-compose pull && docker-compose up`.
Esto hará que todo salga a la vida donde eventualmente conseguirás que se obtengan bloques.
```shell
> #SNIPPET
subquery-node_1 | 2021-06-05T22:20:31.450Z <subql-node> INFO node started
subquery-node_1 | 2021-06-05T22:20:35.134Z <fetch> INFO fetch block [1, 100]
subqlhelloworld_graphql-engine_1 exited with code 0
subquery-node_1 | 2021-06-05T22:20:38.412Z <fetch> INFO fetch block [101, 200]
graphql-engine_1 | 2021-06-05T22:20:39.353Z <nestjs> INFO Starting Nest application...
graphql-engine_1 | 2021-06-05T22:20:39.382Z <nestjs> INFO AppModule dependencies initialized
graphql-engine_1 | 2021-06-05T22:20:39.382Z <nestjs> INFO ConfigureModule dependencies initialized
graphql-engine_1 | 2021-06-05T22:20:39.383Z <nestjs> INFO GraphqlModule dependencies initialized
graphql-engine_1 | 2021-06-05T22:20:39.809Z <nestjs> INFO Nest application successfully started
subquery-node_1 | 2021-06-05T22:20:41.122Z <fetch> INFO fetch block [201, 300]
graphql-engine_1 | 2021-06-05T22:20:43.244Z <express> INFO request completed
```
## 6. Examinar parque
Vaya a http://localhost:3000/ y pegue la siguiente consulta en el lado izquierdo de la pantalla y pulse el botón Reproducir.
```
# Yarn
yarn build
# NPM
npm run-script build
```
Zona de juegos SubQuery en localhost.
El número de bloques en el patio de juego debe coincidir con el número de bloques (técnicamente la altura del bloque) en la terminal también.
## Resúmen
En este inicio rápido, demostramos los pasos básicos para poner en marcha un proyecto inicial dentro de un entorno Docker y luego navegamos a localhost:3000 y ejecutamos una consulta para devolver el número de bloque de la red mainnet Polkadot.