Skip to content

Commit 9d394b4

Browse files
nhussein11nhussein11
committed
Merge branch 'master' into nhussein11/fix-light-clients
2 parents 04fec02 + 2636f5e commit 9d394b4

File tree

14 files changed

+338
-33
lines changed

14 files changed

+338
-33
lines changed

‎.github/scripts/check_dependencies.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ def check_releases(releases_source_file):
7373
continue
7474

7575
for name, info in items.items():
76+
# Skip dependencies marked with ignore_updates=true
77+
if info.get("ignore_updates", False):
78+
continue
79+
7680
current_version = info.get("version")
7781
latest_version, latest_url = REGISTRIES[category](info)
7882

‎.snippets/code/develop/toolkit/parachains/quickstart/pop-cli/call-chain.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div id="termynal" data-termynal>
2+
<img src="../../../../../../../images/develop/toolkit/parachains/quickstart/call-chain.gif" alt="pop call" style="max-width: 100%" />
3+
</div>

‎.snippets/code/develop/toolkit/parachains/quickstart/pop-cli/install.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<div id="termynal" data-termynal>
2+
<span data-ty="input"><span class="file-path"></span>pop install</span>
3+
<span data-ty>┌ Pop CLI : Install dependencies for development</span>
4+
<span data-ty>│ </span>
5+
<span data-ty></span>
6+
<span data-ty>⚙ ℹ️ Mac OS (Darwin) detected.</span>
7+
<span data-ty>│ </span>
8+
<span data-ty>⚙ More information about the packages to be installed here: https://docs.substrate.io/install/macos/</span>
9+
<span data-ty>│ </span>
10+
<span data-ty>◆ 📦 Do you want to proceed with the installation of the following packages: homebrew, protobuf, openssl, rustup and cmake ?</span>
11+
<span data-ty>│ ● Yes / ○ No </span>
12+
</div>

‎.snippets/code/develop/toolkit/parachains/quickstart/pop-cli/new-parachain.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div id="termynal" data-termynal>
2+
<img src="../../../../../../../images/develop/toolkit/parachains/quickstart/pop-new.gif" alt="pop new" style="max-width: 100%" />
3+
</div>

‎develop/toolkit/parachains/.pages‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
title: Parachains
22
nav:
33
- index.md
4-
- 'Light Clients': light-clients.md
4+
- quickstart
55
- spawn-chains
66
- fork-chains
7-
- e2e-testing
7+
- e2e-testing
8+
- 'Light Clients': light-clients.md

‎develop/toolkit/parachains/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This section explores essential tools for blockchain testing, forking live netwo
1212

1313
## Quick Links
1414

15+
- [Use Pop CLI to start your parachain project](/develop/toolkit/parachains/quickstart/pop-cli/)
1516
- [Use Zombienet to spawn a chain](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/)
1617
- [Use Chopsticks to fork a chain](/develop/toolkit/parachains/fork-chains/chopsticks/get-started/)
1718
- [Use Moonwall to execute E2E testing](/develop/toolkit/parachains/e2e-testing/moonwall/)

‎develop/toolkit/parachains/quickstart/.pages‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: Quickstart Parachain Development
2+
nav:
3+
- index.md
4+
- 'Pop CLI': pop-cli.md

‎develop/toolkit/parachains/quickstart/index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Quickstart Parachain Development
3+
description: Bootstrap your development environment, scaffold template-based projects, deploy local networks, and simplify your workflow with tools for parachain developers.
4+
template: index-page.html
5+
---
6+
7+
# Quickstart Parachain Development
8+
9+
## In This Section
10+
11+
:::INSERT_IN_THIS_SECTION:::

‎develop/toolkit/parachains/quickstart/pop-cli.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Quickstart Parachain Development with Pop CLI
3+
description: Quickly bootstrap parachain projects, scaffold templates, deploy local networks, and streamline development workflows using Pop CLI.
4+
---
5+
6+
# Quickstart Parachain Development With Pop CLI
7+
8+
## Introduction
9+
10+
[Pop CLI](https://onpop.io/cli/){target=\_blank} is a powerful command-line tool designed explicitly for rapid parachain development within the Polkadot ecosystem. It addresses essential developer needs by providing streamlined commands to set up development environments, scaffold parachain templates, and manage local blockchain networks.
11+
12+
Pop CLI simplifies parachain development with features like:
13+
14+
- Quick initialization of parachain development environments
15+
16+
- Project scaffolding from predefined parachain templates
17+
18+
- Easy deployment and management of local development networks
19+
20+
Developers can quickly begin coding and testing, significantly reducing setup overhead.
21+
22+
### Install Pop CLI
23+
24+
To install Pop CLI, run the following command:
25+
26+
```bash
27+
cargo install --force --locked pop-cli
28+
```
29+
30+
Confirm that Pop CLI is installed by running `pop --help` in your terminal:
31+
32+
```bash
33+
pop --help
34+
```
35+
36+
### Set Up Your Development Environment
37+
38+
To develop and build Polkadot SDK-based chains, preparing your local environment with the necessary tools and dependencies is essential. The [Install Polkadot SDK Dependencies](/develop/parachains/install-polkadot-sdk/){target=\_blank} guide walks you through this setup step-by-step.
39+
40+
However, you can automate this entire process by running:
41+
42+
```bash
43+
pop install
44+
```
45+
46+
This command provides an interactive experience that checks and installs all necessary dependencies for you. It’s the fastest and easiest way to prepare your development environment for building parachains with Pop CLI.
47+
48+
--8<-- 'code/develop/toolkit/parachains/quickstart/pop-cli/install.html'
49+
50+
### Initialize a Project
51+
52+
Start a new project quickly using Pop CLI's `pop new parachain` command:
53+
54+
--8<-- 'code/develop/toolkit/parachains/quickstart/pop-cli/new-parachain.html'
55+
56+
The command above scaffolds a new parachain project using the default template included with Pop CLI. For more specialized implementations, additional templates are available; you can explore them by running `pop new parachain --help`.
57+
58+
Once the project is generated, move into the new directory and build your parachain:
59+
60+
```
61+
cd my-parachain
62+
pop build --release
63+
```
64+
65+
!!! note
66+
Under the hood, `pop build --release` runs `cargo build --release`, but `pop build` adds functionality specific to Polkadot SDK projects, such as [deterministic runtime builds](/develop/parachains/deployment/build-deterministic-runtime/){target=\_blank} and automatic management of feature flags like `benchmark` or `try-runtime`.
67+
68+
Pop CLI integrates the [Zombienet SDK](https://github.com/paritytech/zombienet-sdk){target=\_blank} allowing you to easily launch ephemeral local networks for development and testing. To start a network, simply run the following:
69+
70+
```bash
71+
pop up network -f ./network.toml
72+
```
73+
74+
This command will automatically fetch the necessary binaries and spin up a Polkadot network with your configured parachains.
75+
76+
You can also interact with your local network using Pop CLI's `pop call chain` command:
77+
78+
--8<-- 'code/develop/toolkit/parachains/quickstart/pop-cli/call-chain.html'
79+
80+
## Where to Go Next
81+
82+
For a comprehensive guide to all Pop CLI features and advanced usage, see the official [Pop CLI](https://learn.onpop.io/appchains) documentation.
83+
!!! tip
84+
Pop CLI also offers powerful solutions for smart contract developers. If you're interested in that path, check out the [Pop CLI Smart Contracts](https://learn.onpop.io/contracts) documentation.

‎images/develop/toolkit/parachains/quickstart/call-chain.gif‎

703 KB
Loading

0 commit comments

Comments
 (0)