Skip to main content

Module 5: Projects & Explorer

SubQuery TeamAbout 2 min

Module 5: Projects & Explorer

SubQuery Manged Service is our managed service solution and SubQuery Explorer is a dashboard where you can find projects and consume project data using GraphQL. This module takes a deeper dive into both these products.

Lesson 1 - Deploying a project


References

Lesson 2 - What are SubQuery Slots and How to Use Them?


References

Lesson 3 - Exploring Projects


Exercise

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

Note

“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

Overview of 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 Managed Service are outlined within our documentation website. Please visit this section.

The process begins with a starter project, then uploads it to GitHub, connects GitHub to SubQuery Managed Service, and then deploys it.

You can deploy any project of your choice to SubQuery Managed Service. But the most appropriate would be a project from the previous module.

Step 2: Switch GitHub Accounts

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

Step 3: Override 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: Understand the Slots

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

Step 5: Access Playground

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

Step 6: Query via the API

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

Step 7: Delete 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