Skip to main content

Getting Started

Follow the instructions below to set up your development environment for Substrate.

Substrate Core​

  1. Install Rust. Make sure you have at least version 1.70.0.
  2. Install just by running cargo install just.
  3. Enable git commit signing.
  4. Fork the substrate2 repository.
  5. Clone your fork.
  6. From the root of your cloned substrate2 repo, run just check and just test. Ensure these commands complete with no errors.

Documentation​

  1. Install NodeJS. We recommend using a version manager like nvm.
  2. Install yarn.
  3. Change into the docs/substrate directory inside your cloned substrate2 repo.
  4. Run yarn install.
  5. Run yarn start. Ensure that the documentation website opens in your browser and that there are no errors logged.

Reading​

Read the Substrate README and contributing guide.