Membuat Proyek SubQuery

Dalam panduan mulai cepat, kami dengan cepat menjalankan contoh untuk memberi Anda gambaran tentang apa itu SubQuery dan cara kerjanya. Di sini kita akan melihat lebih dekat alur kerja saat membuat proyek Anda dan file kunci yang akan Anda ikut sertakan.

Alur Kerja Dasar

Beberapa contoh berikut akan menganggap Anda telah berhasil menginisialisasi paket starter di bagian Mulai cepat. Dari paket awal itu, kita akan menjalani proses standar untuk menyesuaikan dan mengimplementasikan proyek SubQuery Anda.

1. Inisialisasi proyek Anda menggunakan subql init PROJECT_NAME.
2. Perbarui file Manifest (project.yaml) untuk menyertakan informasi tentang blockchain Anda, dan entitas yang akan Anda petakan - lihat File Manifest
3. Buat entitas GraphQL di skema Anda (schema.graphql) yang menentuakn bentuk data yang akan Anda ekstrak dan coba untuk kueri - lihat Skema GraphQL
4. Tambahkan semua fungsi pemetaan (mis mappingHandlers.ts yang ingin Anda minta untuk ubah data chainnya ke entitas GraphQL yang sudah Anda tentukan - lihat Pemetaan
5. Hasilkan, bentuk, dan terbitkan kode Anda ke Proyek SubQuery (atau jalankan di node lokal Anda) - lihat Menjalankan dan Mengkueri Proyek Pemula Anda di panduan mulai cepat kami.

Struktur Direktori

Peta berikut ini memberikan gambaran struktur direktori proyek SubQuery saat perintah init berjalan.

- project-name
  L package.json
  L project.yaml
  L README.md
  L schema.graphql
  L tsconfig.json
  L docker-compose.yml
  L src
    L index.ts
    L mappings
      L mappingHandlers.ts
  L .gitignore

Sebagai contoh:

Pembuatan Kode

Kapan pun Anda mengubah entitas GraphQL Anda, Anda harus menghasilkan ulang direktori jenis Anda dengan perintah berikut.

yarn codegen

Ini akan membuat direktori baru (atau memperbarui yang sudah ada) src/types yang berisi kelas entitas yang dihasilkan untuk setiap jenis yang telah Anda tetapkan sebelumnya di schema.graphql. Kelas-kelas ini menyediakan akses entitas yang aman untuk memuat, membaca dan menulis ke bidang entitas - lihat selengkapnya tentang proses ini di Skema GraphQL.

Bentuk

Untuk menjalankan Proyek SubQuery Anda di host Node SubQuery secara lokal, pertama-tama Anda perlu membentuk pekerjaan Anda.

Jalankan perintah bentuk dari direktori proyek.

::: code-tabs @tab:active yarn shell yarn build