Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694

Merged
merged 4 commits into from
Sep 22, 2023
Merged

feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694

Changes from all 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 Sep 14, 2023
b9150b3
add js-kubo-rpc-client, restructure page
ElPaisano Sep 18, 2023
1689263
fix(docs): Add kubo reference.
whizzzkid Sep 21, 2023
0f6c161
js-kubo-rpc-client get started updates
ElPaisano Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions docs/reference/js/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,21 @@

# IPFS in JavaScript
Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added mention in b9150b3


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

To get started with the js-kubo-rpc-client, do the following:

1. Ensure that you have [kubo](https://github.com/ipfs/kubo) running. Since we're working with Node.js, you can [install kubo using npm](https://www.npmjs.com/package/kubo).

Check failure on line 23 in docs/reference/js/api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/js/api.md#L23 

[ipfs-docs-style.PLNSpelling] Did you really mean 'npm'?
Raw output 
{"message": "[ipfs-docs-style.PLNSpelling] Did you really mean 'npm'?", "location": {"path": "docs/reference/js/api.md", "range": {"start": {"line": 23, "column": 133}}}, "severity": "ERROR"}
1. Next, [install the client using `npm`, or load it as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install).
1. Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information.
Loading