Hello World (localhost & Docker)

... 2022-9-24 Khoảng 4 phút

# Hello World (localhost & Docker)

Chào mừng bạn đến với phần khởi đầu nhanh SubQuery Hello World. Khởi động nhanh nhằm mục đích chỉ cho bạn cách bạn có được dự án khởi động mặc định đang chạy trong Docker trong một vài bước đơn giản.

# Mục tiêu học tập

Khi kết thúc phần quick start này, bạn sẽ:

  • hiểu các yêu cầu bắt buộc
  • hiểu các lệnh phổ biến cơ bản
  • có thể điều hướng đến localhost:3000 và xem sân chơi
  • chạy một truy vấn đơn giản để lấy chiều cao khối của mạng chính Polkadot

# Đối tượng mục tiêu

Hướng dẫn này hướng tới các nhà phát triển mới đã có một số kinh nghiệm phát triển và muốn tìm hiểu thêm về SubQuery.

# Video hướng dẫn

# Điều kiện tiên quyết

Bạn sẽ cần:

  • quản lý gói yarn hoặc npm
  • SubQuery CLI (@subql/cli)
  • Docker

Bạn có thể chạy các lệnh sau trong một thiết bị đầu cuối để xem liệu bạn đã có bất kỳ điều kiện tiên quyết nào trong số này chưa.

yarn -v (or npm -v)
subql -v
docker -v
1
2
3

Đối với người dùng nâng cao hơn, hãy sao chép và dán nội dung sau:

echo -e "My yarn version is:" `yarn -v` "\nMy subql version is:" `subql -v`  "\nMy docker version is:" `docker -v`
1

Điều này sẽ trả về: (đối với người dùng npm, thay thế yarn bằng npm)

My yarn version is: 1.22.10
My subql version is: @subql/cli/0.9.3 darwin-x64 node-v16.3.0
My docker version is: Docker version 20.10.5, build 55c4c88
1
2
3

Nếu bạn đạt được những điều trên, thì bạn đã tốt để tiếp tục. Nếu không, hãy nhấp vào các liên kết sau để cài đặt chúng:

# 1. Khởi tạo dự án

Bước đầu tiên khi bắt đầu với SubQuery là chạy lệnh subql init. Hãy khởi tạo một dự án bắt đầu với tên subqlHelloWorld. Lưu ý rằng chỉ tác giả là bắt buộc. Mọi thứ khác được để trống bên dưới.

> subql init subqlHelloWorld
? Lựa chọn một mạng Polkadot
? Select a template project subql-starter     Starter project for subquery
Cloning project... done
RPC endpoint: [wss://polkadot.api.onfinality.io/public-ws]:
Git repository [https://github.com/subquery/subql-starter]:
Fetching network genesis hash... done
Author [Ian He & Jay Ji]:
Description [This project can be use as a starting po...]:
Version [0.0.4]:
License [MIT]:
Preparing project... done
subqlHelloWorld is ready

1
2
3
4
5
6
7
8
9
10
11
12
13
14

Đừng quên thay đổi thành thư mục mới này.

cd subqlHelloWorld
1

# 2. Cài đặt phần phụ thuộc

Bây giờ cài đặt yarn hoặc node để cài các phụ thuộc khác nhau.

Ví dụyarn install

> 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.
1
2
3
4
5
6
7
8
9

# 3. Tạo mã

Bây giờ, hãy chạy yarn codegen để tạo Typescript từ sơ đồ GraphQL.

Ví dụyarn 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.
1
2
3
4
5
6
7
8
9
10

Cảnh báo Khi các thay đổi được thực hiện đối với tệp giản đồ, hãy nhớ chạy lại yarn codegen để tạo lại thư mục của bạn.

# 4. Xây dựng mã

Bước tiếp theo là xây dựng mã với yarn build.

Ví dụ yarn build

> yarn build
yarn run v1.22.10
$ tsc -b
✨  Done in 5.68s.
1
2
3
4

# 5. Chạy Docker

Sử dụng Docker cho phép bạn chạy ví dụ này rất nhanh vì tất cả cơ sở hạ tầng cần thiết có thể được cung cấp trong hình ảnh Docker. Run docker-compose pull && docker-compose up.

Điều này sẽ thúc đẩy mọi thứ vào cuộc sống, nơi cuối cùng bạn sẽ nhận được các khối đang được nạp.

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

1
2
3
4
5
6
7
8
9
10
11
12
13

# 6. Duyệt qua sân chơi

Vào trang web http://localhost:3000/ và dán truy vấn bên dưới vào bên trái màn hình rồi nhấn nút play.

{
 query{
   starterEntities(last:10, orderBy:FIELD1_ASC ){
     nodes{
       field1
     }
   }
 }
}

1
2
3
4
5
6
7
8
9
10

Sân chơi SubQuery trên localhost.

sân chơi localhost

Số khối trong playground cũng phải khớp với số khối (về mặt kỹ thuật là chiều cao khối) trong thiết bị đầu cuối.

# Tóm lược

Trong phần khởi động nhanh này, chúng tôi đã trình bày các bước cơ bản để thiết lập và chạy một dự án mới bắt đầu trong môi trường Docker, sau đó điều hướng đến localhost: 3000 và chạy một truy vấn để trả về số khối của mạng chính Polkadot.

Cập nhật gần nhất lúc: September 24, 2022 05:55