-
Notifications
You must be signed in to change notification settings - Fork 411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6350978
feat(js): :recycle: Adding references to helia.io + Old js-ipfs stuff.
whizzzkid b9150b3
add js-kubo-rpc-client, restructure page
ElPaisano 1689263
fix(docs): Add kubo reference.
whizzzkid 0f6c161
js-kubo-rpc-client get started updates
ElPaisano File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,10 +5,17 @@ description: Developer resources for working in JavaScript with IPFS, the InterP | |
|
||
# IPFS in JavaScript | ||
|
||
Developers can get started with IPFS in JavaScript using Helia, a lean, modular, and modern implementation of IPFS for the JS and browser environments. Helia superseded [js-ipfs](https://github.com/ipfs/js-ipfs), which was the first JS implementation. Learn more at [https://github.com/ipfs/helia](https://github.com/ipfs/helia). | ||
Developers can get started with IPFS in JavaScript (JS) using several options: | ||
|
||
## Hands-on examples | ||
- [IPFS Helia](https://helia.io): a lean, modular, and modern implementation of IPFS for the JS and browser environment | ||
ElPaisano marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [js-kubo-rpc-client](https://github.com/ipfs/js-kubo-rpc-client): A JS client library for the [Kubo RPC API](../kubo/rpc.md) | ||
|
||
New to IPFS or JavaScript? Get started with the [Helia 101 example](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-101), which will walk you through spawning a Helia node, adding a file, and `cat`-ing the file CID both locally and through an IPFS gateway. | ||
## Get started | ||
|
||
Additional Helia examples can be found [here](https://github.com/ipfs-examples/helia-examples/tree/main). | ||
### Helia | ||
|
||
New to IPFS Helia? The [Helia 101 example](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-101) will walk you through spawning a Helia node, adding a file, and `cat`-ing the file CID both locally and through an IPFS gateway. More advanced Helia examples can be found [here](https://github.com/ipfs-examples/helia-examples/tree/main). | ||
|
||
### js-kubo-rpc-client | ||
|
||
First, [install the client using `npm` or as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install). Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We also should mention that one needs to install Kubo. This can be done with https://www.npmjs.com/package/kubo There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page should discuss the various ways one can "interface with IPFS" with JavaScript. Helia isn't the only way. At the minimum, we should add the js-kubo-rpc-client.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added mention in b9150b3