Skip to content

Commit 1d932d2

Browse files
authored
Update readme with latest dev steps (#2168)
1 parent 473ede4 commit 1d932d2

File tree

2 files changed

+29
-52
lines changed

2 files changed

+29
-52
lines changed

DEPLOY-RELEASE.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# Deploying docs and releasing substrate connect
22

3-
## Releasing
4-
5-
TODO
3+
TODO: This is out of date. Update this to reflect the new release steps once we
4+
get to doing a release.
65

76
## Deploy Smoldot browser demo to Github Pages
87

98
Before deploying make sure you have a clean working copy with no staged changes.
109
The deploy script will deploy the last commit on your current branch.
1110

12-
The deployment will build the smoldot browser demo into the dist folder and
13-
construct a commit containing just that folder with a message containing a
11+
The deployment will build the smoldot browser demo into the dist folder and
12+
construct a commit containing just that folder with a message containing a
1413
reference to the SHA of the commit it came from and push that to the gh-pages
1514
branch. The dist folder remains ignored by git.
1615

README.md

+25-47
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ securely connect to the blockchain network without relying on specific 3rd parti
77

88
Due to browser limitations on websockets from https pages, establishing a good
99
number of peers is difficult as many nodes need to be available with TLS. Substrate
10-
connect provides a browser extension to overcome this limitation and to keep
10+
connect provides a browser extension to overcome this limitation and to keep
1111
the chains synced in the background, which makes your apps faster.
1212

1313
When building an app with substrate connect, it will detect whether the user has
@@ -23,30 +23,31 @@ The substrate connect [API documentation is published here](https://paritytech.g
2323

2424
This repository is using [pnpm workspaces](https://pnpm.io/workspaces).
2525

26-
We are tracking our work and milestones in a [github project](https://github.com/paritytech/substrate-connect/projects/1).
26+
We also use `corepack`, which ensures that the correct version of `pnpm` is used.
2727

2828
Please see our [contributing guidelines](./CONTRIBUTING.md) for details on how
2929
we like to work and how to smoothly contribute to the project.
3030

31-
## Getting Started
32-
33-
1. Clone the whole `substrate-connect` repository.
34-
35-
```bash
36-
git clone https://github.com/paritytech/substrate-connect.git
37-
```
38-
39-
2. Install all dependencies
40-
41-
```bash
42-
corepack pnpm install
43-
```
44-
45-
3. Compile all packages and projects
46-
47-
```bash
48-
corepack pnpm build
49-
```
31+
### Getting Started
32+
33+
If you're hacking on this repository, here's how to install everything and spin up a demo:
34+
35+
1. Install any prerequisites. These steps were tested with:
36+
- Node.js (node) v20.9.0.
37+
- pnpm 9.0.6 (`npm install -g pnpm`).
38+
- corepack 0.20.0 (This should be bundled with recent Node.js versions).
39+
2. Clone the repository.
40+
- `git clone https://github.com/paritytech/substrate-connect.git`
41+
- `cd substrate-connect` to navigate to the repository root.
42+
3. Install the dependencies.
43+
- `corepack pnpm install`
44+
4. In terminal A, run `cd projects/extension && corepack pnpm dev`.
45+
5. In terminal B, run `cd projects/extension && corepack pnpm start`.
46+
- This will open a Chrome browser window with the extension pre-loaded.
47+
- Make sure that the extension is running.
48+
6. In terminal C, run `cd projects/demo && corepack pnpm dev`.
49+
- Navigate to the URL that this logs in the Chrome browser that opened in 5.
50+
- You should see the extension come to life and the demo app log latest blocks.
5051

5152
To clean up all build artefacts in workspaces in the repository, run:
5253

@@ -60,35 +61,12 @@ To clean up all build artefacts and dependencies in workspaces in the repository
6061
corepack pnpm deep-clean
6162
```
6263

63-
## Run local version of Smoldot Extension
64-
Running the following command will build all necessary dependencies and run the Smoldot Extension in development mode with hot reloading enabled. Once run a new (Chrome) browser will appear with the extension added.
65-
66-
```bash
67-
corepack pnpm dev:extension
68-
```
69-
70-
(Make sure to run `$ pnpm install` before.)
71-
72-
## Run local version of Burnr wallet
73-
Running the following command will build all necessary dependencies and run the Substrate Burnr Wallet in development mode with hot reloading enabled. It will be served on http://localhost:1234/
74-
75-
```bash
76-
corepack pnpm dev:burnr
77-
```
78-
79-
(Make sure to run `$ pnpm install` before.)
80-
81-
82-
## [Deployments and releases](./DEPLOY-RELEASE.md)
83-
84-
85-
## Substrate Connect Extension
64+
## Releasing
8665

87-
A Browser extension that keeps the latest state of well known substrate-based chains' specs and bootnodes (Polkadot, Kusama, Rococo, Westend) synced across tabs - using Substrate Connect and Smoldot light client;
66+
Visit [the release doc](./DEPLOY-RELEASE.md) and follow the steps there to release a new version of the extension.
8867

89-
The Extension is using Substrate Connect and Smoldot light client node modules. This extension, upon browser initiation updates and synchronizes in the well known substrate chain specs (Polkadot, Kusama, Rococo, Westend), keeping them to the latest state inside the extension, for faster chain sync. When a dApp that supports Substrate Connect (e.g. polkadotJS apps) starts in a browser's tab, then it receives the latest specs from the Extension instead of wrap-syncing from the last imported inside the dApp; At the same time, the dApp will appear inside the Extension as "connected" - meaning that it is using the Extension's bootnodes and specs;
68+
## Useful Links
9069

91-
## Useful Links:
9270
[Substrate Connect Documentation Page](https://substrate.io/developers/substrate-connect/)
9371

9472
Download at:

0 commit comments

Comments
 (0)