https://github.com/nhussein11/subgraph-explorer
A full-stack application using The Graph protocol to create and deploy a subgraph, and then Next.js to consume the data
https://github.com/nhussein11/subgraph-explorer
blockchain graphql nextjs thegraphprotocol web3
Last synced: 6 months ago
JSON representation
A full-stack application using The Graph protocol to create and deploy a subgraph, and then Next.js to consume the data
- Host: GitHub
- URL: https://github.com/nhussein11/subgraph-explorer
- Owner: nhussein11
- Created: 2023-03-09T14:32:06.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T13:20:03.000Z (over 2 years ago)
- Last Synced: 2025-03-04T09:42:25.434Z (10 months ago)
- Topics: blockchain, graphql, nextjs, thegraphprotocol, web3
- Language: TypeScript
- Homepage: https://subgraph-explorer.vercel.app
- Size: 29.5 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Subgraph Explorer
This is a subgraph explorer for the [Graph](https://thegraph.com/). It allows you to explore the subgraphs deployed to the Graph and their entities.
The idea of this project is to show how to build a subgraph explorer using the Graph, deploy it to the Graph and use it to explore the subgraphs deployed to the Graph and finally consume the data using Nextjs.
## Getting Started :books:
To get started, clone the repository and install the dependencies:
**_ Note: This project uses yarn _**
```bash
git clone https://github.com/nhussein11/subgraph-explorer.git
```
First, you need to install the dependencies for the subgraph explorer.
```bash
cd subgraph-explorer
```
```bash
yarn install
```
After that, you need to install the dependencies for the frontend
```bash
cd frontend
```
```bash
yarn install
```
## Running the project :running:
To run the project, you need to only run the frontend, because I've deployed the subgraph explorer to the Graph.
```bash
cd frontend
```
```bash
yarn dev
```
## Deploying the subgraph explorer to the Graph :rocket:
To deploy the subgraph explorer to the Graph, I highly recommend you to read the [Graph documentation](https://thegraph.com/docs/quick-start).
Specifically, you need to read the [Create a Subgraph](https://thegraph.com/docs/create-a-subgraph) and the [Deploy a Subgraph](https://thegraph.com/docs/en/deploying/subgraph-studio/) sections.
Then, you will understand how to create and deploy a subgraph to the Graph.
# Contributing :heart:
If you want to contribute to this project, feel free to open a pull request or an issue. I will be happy to review it.