universal-connectivity icon indicating copy to clipboard operation
universal-connectivity copied to clipboard

Create a tutorial

Open p-shahi opened this issue 2 years ago • 4 comments

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

p-shahi avatar May 05 '23 00:05 p-shahi

1st draft: https://hackmd.io/@F8NONPbbRv-IVOAPB7tKPw/SyQeJn8Nh

p-shahi avatar May 11 '23 21:05 p-shahi

@TheDiscordian how are things going on this front?

p-shahi avatar May 12 '23 15:05 p-shahi

second draft https://hackmd.io/@Disscordian/SyeIrTkH2

dhuseby avatar May 25 '23 22:05 dhuseby

@TheDiscordian is the Go version of the doc a final draft?

dhuseby avatar Jun 01 '23 22:06 dhuseby