-
Notifications
You must be signed in to change notification settings - Fork 144
Closed
Description
Done Criteria
The relevant examples below from https://github.com/ipfs-examples/js-ipfs-examples have been replicated in https://github.com/ipfs-examples/helia-examples
Why Important
- Tangible examples that are verified as part of CI are a great hands-on way for a user to get started.
- The act of porting/writing examples is a great way for new contributors to help and to learn, flex, and give feedback on the Helia API
User/Customer
- New users of Helia
- Maintainers
List of examples (in priority order)
### Tooling integration
- [x] browser-webpack
- [x] browser-vite: https://github.com/ipfs-examples/helia-examples/pull/16
- [x] browser-nextjs: https://github.com/ipfs-examples/helia-examples/pull/22
- [x] browser-vue: https://github.com/ipfs-examples/helia-examples/pull/24
- [ ] browser-angular - @polus-arcticus
- [ ] browser-create-react-app: https://github.com/ipfs-examples/helia-examples/pull/35
- [x] browser-esbuild: https://github.com/ipfs-examples/helia-examples/pull/34
- [ ] browser-lit
### Features
- [x] ipfs-101
- [x] cjs
- [x] browser-script-tag: https://github.com/ipfs-examples/helia-examples/pull/13
- [ ] browser-add-readable-stream: https://github.com/ipfs-examples/helia-examples/pull/64
- [ ] browser-ipns-publish
- [ ] browser-mfs
- [ ] browser-readablestream - @ElPaisano
- [ ] browser-service-worker
- [ ] browser-video-streaming
- [ ] circuit-relaying
- [ ] custom-ipfs-repo
- [ ] custom-ipld-formats
- [ ] custom-libp2p
- [x] run-in-electron: https://github.com/ipfs-examples/helia-examples/pull/33
- [ ] traverse-ipld-graphs
Backlog
### Features (Bigger endeavors since are standalone sites)
- [ ] https://github.com/ipld/explore.ipld.io/issues/117
- [ ] https://github.com/ipfs-shipyard/ipfs-share-files/issues/136
### Features (Skip for now, external dependency on webrtc browser to browser transport)
- [ ] browser-exchange-files
### Features (Skip for now, external dependency on rpc client)
- [ ] http-client-browser-pubsub
- [ ] http-client-bundle-webpack
- [ ] http-client-name-api
- [ ] http-client-upload-file
- [ ] ipfs-client-add-files
### Back burner (Skip for now, may need more thought or not be necessary)
- [ ] types-use-ipfs-from-ts
- [ ] types-use-ipfs-from-typed-js
- [ ] browser-sharing-node-across-tabs
- [ ] running-multiple-nodes
Notes
- This isn't racking new examples, just the porting over of https://github.com/ipfs-examples/js-ipfs-examples
- ✅ This is assuming the example repo/infra gets setup: Examples repo/infra setup #29
- A js-ipfs migration guide is here: https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels