difftreelog
Add end user documentation
in: master
4 files changed
README.mddiffbeforeafterboth1# Substrate Node Template1# NFT Parachain223A new Substrate node, ready for hacking. This node includes:3## Application Development445* A FRAME-based runtime5If you are building an application that operates NFT tokens, use [this guide](doc/application_development.md).6* A template pallet7* Aura block authoring8* Grandpa finality gadget9610## Build7## Building11812Install Rust:9Install Rust:131014```bash11```bash15curl https://sh.rustup.rs -sSf | sh12curl https://sh.rustup.rs -sSf | sh13rustup default nightly14sudo apt-get install libssl-dev pkg-config libclang-dev clang1516```16```171718Initialize your Wasm Build environment:18Install required tools:191920```bash20```bash21./scripts/init.sh21./scripts/init.sh22```22```232324Build Wasm and native code:24Build the WebAssembly binary:252526```bash26```bash27cargo build --release27./scripts/build.sh28```28```292930## Run30Build all native code:313132### Single Node Development Chain3334Purge any existing developer chain state:3536```bash32```bash37./target/release/node-template purge-chain --dev33cargo build --release38```34```393540Start a development chain with:36## Run413738You can start a development chain with:3942```bash40```bash43./target/release/node-template --dev41cargo run -- --dev44```42```454346Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.44Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.474548### Multi-Node Local Testnet46If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units. Give each node a name and expose them so they are listed on the Polkadot [telemetry site](https://telemetry.polkadot.io/#/Local%20Testnet). You'll need two terminal windows open.494750If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units.48We'll start Alice's substrate node first on default TCP port 30333 with her chain database stored locally at `/tmp/alice`. The bootnode ID of her node is `QmQZ8TjTqeDj3ciwr93EJ95hxfDsb9pEYDizUAbWpigtQN`, which is generated from the `--node-key` value that we specify below:514952Optionally, give each node a name and expose them so they are listed on the Polkadot [telemetry site](https://telemetry.polkadot.io/#/Local%20Testnet).5354You'll need two terminal windows open.5556We'll start Alice's substrate node first on default TCP port 30333 with her chain database stored locally at `/tmp/alice`. The bootnode ID of her node is `QmRpheLN4JWdAnY7HGJfWFNbfkQCb6tFf4vvA6hgjMZKrR`, which is generated from the `--node-key` value that we specify below:5758```bash50```bash59cargo run -- \51cargo run -- \60 --base-path /tmp/alice \52 --base-path /tmp/alice \70```bash62```bash71cargo run -- \63cargo run -- \72 --base-path /tmp/bob \64 --base-path /tmp/bob \73 --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/QmRpheLN4JWdAnY7HGJfWFNbfkQCb6tFf4vvA6hgjMZKrR \65 --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/QmQZ8TjTqeDj3ciwr93EJ95hxfDsb9pEYDizUAbWpigtQN \74 --chain=local \66 --chain=local \75 --bob \67 --bob \76 --port 30334 \68 --port 30334 \77 --telemetry-url ws://telemetry.polkadot.io:1024 \69 --telemetry-url ws://telemetry.polkadot.io:1024 \78 --validator70 --validator79```8081Additional CLI usage options are available and may be shown by running `cargo run -- --help`.8283## Advanced: Generate Your Own Substrate Node Template8485A substrate node template is always based on a certain version of Substrate. You can inspect it by86opening [Cargo.toml](Cargo.toml) and see the template referred to a specific Substrate commit(87`rev` field), branch, or version.8889You can generate your own Substrate node-template based on a particular Substrate90version/commit by running following commands:9192```bash93# git clone from the main Substrate repo94git clone https://github.com/paritytech/substrate.git95cd substrate9697# Switch to a particular branch or commit of the Substrate repo your node-template based on98git checkout <branch/tag/sha1>99100# Run the helper script to generate a node template.101# This script compiles Substrate and takes a while to complete. It takes a relative file path102# from the current dir. to output the compressed node template.103.maintain/node-template-release.sh ../node-template.tar.gz104```71```10572106Noted though you will likely get faster and more thorough support if you stick with the releases73Additional CLI usage options are available and may be shown by running `cargo run -- --help`.107provided in this repository.108doc/application_development.mddiffbeforeafterbothno changes
doc/server_architecture.pngdiffbeforeafterbothbinary blob — no preview
doc/serverless_architecture.pngdiffbeforeafterbothbinary blob — no preview