Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Commit

Permalink
fix: README update on docker usage (#43)
Browse files Browse the repository at this point in the history
* use docker to setup a local dev chain.

* install docker link

* update command

* Update README.md

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

* more commands to start or check a node.

* purge chain in docker

* update README

Co-authored-by: Kaichao Sun <kaichaosuna@gmail.com>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
  • Loading branch information
3 people authored May 15, 2020
1 parent 1b85882 commit 3323afa
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,27 +82,24 @@ Additional CLI usage options are available and may be shown by running `cargo ru

### Run in Docker

Install [Docker](https://docs.docker.com/get-docker/) first, then run the following command to start a single node development chain. This command will firstly comipile your code, then start a local dev netork.
First, install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).

Then run the following command to start a single node development chain.

```bash
./scripts/docker_run.sh
```

If you just want to run the compiled binary,
This command will firstly compile your code, and then start a local development network. You can also replace the default command (`cargo build --release && ./target/release/node-template --dev --ws-external`) by appending your own. A few useful ones are as follow.

```bash
# Run Substrate node without re-compiling
./scripts/docker_run.sh ./target/release/node-template --dev --ws-external
```

Other commands are similar. Let's try purge the local dev chain here:

```bash
# Purge the local dev chain
./scripts/docker_run.sh ./target/release/node-template purge-chain --dev
```

You can also check whether the code is able to compile or not,

```bash
# Check whether the code is compilable
./scripts/docker_run.sh cargo check
```

Expand Down

0 comments on commit 3323afa

Please sign in to comment.