SubQuery Academy (Documentation)

Module 5: Projects & Explorer

SubQuery Team약 2 분

Module 5: Projects & Explorer

Lesson 1 - Deploying a project


Lesson 2 - What are SubQuery slots and how to use them?


Documentation reference

What are deployment slots?

Lesson 3 - Exploring projects


Exercise

Here we will learn what SubQuery Project is, how to deploy a project to SubQuery Project, and learn about SubQuery Explorer.

NB: “SubQuery Project” (uppercase P) is SubQuery’s hosted solution. SubQuery project (lowercase p) refers to a general SubQuery project such as the “account transfer SubQuery project”.

Pre-requisites

None

Deploying your project

High level steps

  1. Upload your project to GitHub
  2. Connect SubQuery Project to GitHub
  3. Create a project
  4. Deploy your project
  5. Testing your project in playground

Detailed steps

Step 1: Hello World (SubQuery hosted)

The detailed steps to deploy a project to SubQuery Projects are outlined on our documentation website at: https://doc.subquery.network/quickstart/helloworld-hosted/open in new window. It takes a starter project, uploads it to GitHub, connects GitHub to SubQuery Projects and then deploys it.

Any project of your choice can be deployed to SubQuery Projects, but the most appropriate would be a project from the previous module.

Step 2: Switching GitHub accounts

It is common to publish your SubQuery project under the name of your GitHub Organization account rather than your personal GitHub account. Please refer to:

Step 3: Overriding endpoints

When deploying your project, it is possible to override your default network or dictionary endpoints with another network. For more information please see:

To understand more about how dictionaries work, refer to:

Step 4: Understanding slots

Slots are a feature in SubQuery's Managed Service that are the equivalent of a development environments. To learn more, visit:

Step 5: Accessing Playground

Once your project is deployed, access your project and run your desired query in playground. For more information, visit:

GraphQL is the language used to query for data. To learn more about GraphQL visit:

Step 6: Querying via the API

Developers will typically query the SubQuery project via API. See an example of how this is done at:

Step 7: Deleting SubQuery projects

It is important to keep your SubQuery projects tidy and ensure that test projects are not running unnecessarily. This consumes extra resources on the network and creates extra cost as well. To delete a project see the guide below:

References