Skip to content

Commit

Permalink
Merge pull request #535 from streamingfast/giu/formatfix
Browse files Browse the repository at this point in the history
format fix
  • Loading branch information
Giuliano-1 authored Sep 17, 2024
2 parents 25a62e6 + e7a2b03 commit 3fef63d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/new/how-to-guides/your-first-application/evm.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In this guide, you'll learn how to initialize an EVM-based Substreams project. Y
Substreams Gui
````
## Step 3: Customize your Project:
## Step 3: Customize your Project
After initialization, you can:
Expand Down
1 change: 0 additions & 1 deletion docs/new/how-to-guides/your-first-application/injective.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ The `injective-events` codegen path relies on one of the [Injective Foundational

Specifically, the `injective-events` path uses the [filtered_events](https://github.com/streamingfast/substreams-foundational-modules/blob/develop/injective-common/substreams.yaml#L58) module from the Injective Foundational Modules to retrieve all the events filtered by event type and/or attributes.

<figure><img src="../../../.gitbook/assets/intro/injective-logo.png" width="100%" /></figure>
2 changes: 1 addition & 1 deletion docs/new/how-to-guides/your-first-application/solana.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In this guide, you'll learn how to initialize an Solana-based Substreams project
Substreams Gui
````
## Step 3: Customize your Project:
## Step 3: Customize your Project
After initialization, you can:
Expand Down
10 changes: 5 additions & 5 deletions docs/new/references/devcontainer-ref.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
The Substreams Development Container (“devcontainer”) is a tool to help you build your first project. You can either run it remotely or clone the [substreams-starter repository](https://github.com/streamingfast/substreams-starter?tab=readme-ov-file) to run it locally. Inside the devcontainer, the `substreams init` command sets up a code-generated Substreams project, allowing you to easily build a subgraph or an SQL-based solution for data handling.

**Prerequisites:**
##Prerequisites

- Ensure Docker and VS Code are up-to-date.

### Navigating the Devcontainer
## Navigating the Devcontainer

Upon entering the devcontainer, you can either insert your `substreams.yaml` file and run `substreams build` to generate Protobuf files or choose one of the auto-generated paths:

- **Minimal**: Extracts raw data from the block.
- **Non-Minimal**: Extracts filtered data using network-specific cache and Protobufs from the Foundational Modules.

### Building Your Project
## Building Your Project

You can configure your Substreams project for querying either through a Subgraph or directly from your SQL database:

- **Subgraph**: Run `substreams codegen subgraph`. This generates a project with a basic `schema.graphql` and `mappings.ts` file. You can customize these to define entities based on the data extracted by Substreams. For more information on configuring a Subgraph sink, see the [Subgraph documentation](https://substreams.streamingfast.io/documentation/consume/subgraph).
- **SQL**: Run `substreams codegen sql` for SQL-based queries. For more information on configuring a SQL sink, refer to the [SQL documentation](https://substreams.streamingfast.io/documentation/consume/sql).

### Deployment Options
## Deployment Options

To deploy a Subgraph, you can either run the `graph-node` locally using the `deploy-local` command or deploy to Subgraph Studio by using the `deploy` command from the `package.json` file.

### Common Errors
## Common Errors

- When running locally, make sure to verify that all Docker containers are healthy by running the `dev-status` command.

0 comments on commit 3fef63d

Please sign in to comment.