How to use it:
git clone https://github.com/shawntabrizi/substrate-package.git.
curl https://getsubstrate.io -sSf | bash -s -- --fast
./substrate-package-rename.sh <project_name> <your_name>
- This renames the project folders, and the binary file that gets created when you compile your runtime
Go into the
<project_name>folder and run:
cargo build --release
- This should start your node, and you should see blocks being created
Go into the
<project_name>-uifolder and run:
yarn run dev
- This should start a web server on
localhost:8000where you can interact with your node
Interact with your node and hack away!
What is this?
- Compatible with the latest documentation available for Substrate Runtime Module development.
- The fastest way to get started building on substrate
- Using Substrate commit: f2f2994822f4331291597e341798fb6271bb6ef4 (
- Using Substrate UI commit: db7bf60ee81cfd1551c8b9a4ad67f0b1d8d331bc (
How was it made?
substrate-node-template was created by running
substrate-ui was created by running
What is tested to work?
substrate-node-templateis fully compatible with
substrate-uiincluded with this package:
- Balance Transfer
- Runtime Upgrades
- Creating new UI elements for new modules
- Gav's Web3 Summit Demo
- Substratekitties Tutorial
- Substrate Documentation
Why do I need
Substrate is a rapidly evolving platform, which means that breaking changes may occur on a day to day basis. Most of the times, these breaking changes do not radically change how substrate works, but may affect how Substrate is organized, the name of functions, the name of modules, etc...
If you try to create a new
substrate-node-template with the
substrate-node-new command, you will pull the latest version of substrate which may not be compatible with different parts of the development ecosystem, such as:
- User Interfaces
substrate-package repository tries to help solve these problems by taking a snapshot of
substrate when it is known to be working and compatible with these different resources.
Most of these issues should go away once Substrate v1.0 is released and we have a stable API.