libp2p / libp2p/universal-connectivity
Create a tutorial
@TheDiscordian is already working on this.
Since May 5, 2023.
- Dominant language
- TypeScript
- Stars
- 167
- Forks
- 75
- PR merge metrics
- No merged PRs in 30d
Description
The outcome of this project should be tutorial that walks through the creation of this sample chat app and teaches users how to run libp2p nodes and make use of these new connectivity options.
We can approach the outcome in a piecemeal approach.
The MVP can be to create a tutorial of just the small network of browser nodes and showcase the WebRTC transport.
The second phase can be to incorporate the server nodes (this can also be done piecemeal, for example we could introduce the server nodes one at a time and make the last leg of the tutorial to connect the server nodes with one another.)
Along with a written example, it'd be great to have a video or a presentation that we can showcase to users (and to an audience at IPFS Thing.)
Something this is also desirable but may be out of scope is an interactive webapp that can demonstrate the connectivity options and enable a user to deploy the local network described above with just a few clicks.
Depends on WebRTC W3C in js-libp2p: https://github.com/libp2p/js-libp2p-webrtc/pull/90 and WebRTC browser-to-server in go-libp2p: https://github.com/libp2p/go-libp2p/pull/1999
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.