README.md

Substreams Starter Dev Kit

Getting Started

Try now, click Open: Your first 60h/month are free!

This will open a fully featured Devcontainer-based development environment, using GitHub Codespaces.

Within the IDE, in a Terminal (F1 -> Terminal: Create New Terminal), run:

substreams init
substreams build
substreams auth
substreams gui
substreams registry login
substreams registry publish

Run help to better navigate the development environment and generate sink projects with:

substreams codegen subgraph
substreams codegen sql

Learn more:

• Tutorials
• Substreams Documentation

Discover community Substreams modules:

• Substreams Registry

Clone in local VSCode

VSCode has excellent support for such containers. See their documentation.

• Install Docker Desktop
• Install VSCode
• Install the Devcontainer Extension in VSCode
• Open this repository, and execute "Rebuild & open in container"

Note

Devcontainers, the environment proposed here, have greatly matured in the past 3 years. They have been standardized, implemented in multiple IDEs and tools, and are used at scale in great companies (eg. Shopify).

Local install

The Devcontainer is the preferred way to develop Substreams. Our documentation generally assumes this environment.

If you prefer, you can install all components locally by following our installation docs.

Included in the dev environment

• substreams preinstalled
• For Substreams development: Rust toolchain, buf and protobuf tooling,
• For subgraph development: node/npm, along with all subgraph services, running in the devcontainer (graph-node, postgres, ipfs) directly accessible locally or remotely.
• Pre-configured VSCode extensions for everything, plus a custom VSCode Substreams Extension.