Practical overview
When it fits
Use it to learn how Substrate components are structured or to consult its examples while building a Substrate-based project. Keep the upstream Substrate version consistent when reusing its pallets and runtimes.
Who it is for
- Developers learning Substrate and FRAME blockchain development.
- Builders seeking example components and node references for Substrate-based projects.
Documented uses
- Study instructional material alongside the code it explains.
- Adapt example pallets and runtimes in a Substrate-based blockchain project.
- Reference consensus-engine and complete-node examples during development.
Requirements & limits
The repository is public, open source and GPL-3.0 licensed. The book can be built and served locally with mdBook.
- The examples span instructional text, pallets, runtimes, consensus engines and complete nodes.
- The README says its pallets and runtimes are tested for use in other Substrate-based blockchains, subject to using the same upstream Substrate version throughout the project.
- The local book-building instructions require mdBook.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build or serve the book locally
Generate the Substrate Recipes book locally or view it through mdBook's local server.
Before you start
- The repository's book source.
- mdBook, installed using the version-parameterized Cargo command in the README.
Steps
Install mdBook with the command below.
cargo install mdbook --vers [version-num]Run
mdbook buildto generate the book in thebooksubdirectory.Open
book/index.htmlin a browser, or runmdbook serveto serve the book locally.
Expected outcome
A locally generated HTML book, or a locally served book at the default address http://localhost:3000.
Guide limitations
- The README recommends using the same mdBook version as the one specified by Rust's rust-book configuration.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 15 October 2026
- Original website title
- JoshOrndorff/substrate-recipes · Official homepage title · retained in its source language

