https://github.com/youaresoroman/react-ipfs

React IPFS instance hooks for easier usage in your DAPPS
https://github.com/youaresoroman/react-ipfs

ipfs react react-hooks reactjs

Last synced: 5 months ago
JSON representation

React IPFS instance hooks for easier usage in your DAPPS

• Host: GitHub
• URL: https://github.com/youaresoroman/react-ipfs
• Owner: youaresoroman
• License: mit
• Created: 2021-08-19T06:57:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-21T15:16:22.000Z (about 2 years ago)
• Last Synced: 2024-11-15T22:09:51.171Z (6 months ago)
• Topics: ipfs, react, react-hooks, reactjs
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/react-ipfs
• Size: 3.5 MB
• Stars: 12
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# react-ipfs

React IPFS instance hooks for easier usage in your DAPPS

 ![npm](https://img.shields.io/npm/dw/react-ipfs) ![David](https://img.shields.io/david/youaresoroman/react-ipfs) ![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/youaresoroman/react-ipfs/ipfs) ![GitHub top language](https://img.shields.io/github/languages/top/youaresoroman/react-ipfs) ![NPM](https://img.shields.io/npm/l/react-ipfs) ![Matrix](https://img.shields.io/matrix/ipfs-awesome:matrix.org?server_fqdn=matrix.org)

 

 

 Ukraine is currently suffering from Russian aggression, please consider donating to [one of these charities](https://old.reddit.com/r/ukraine/comments/s6g5un/want_to_support_ukraine_heres_a_list_of_charities/).




## Installation

### npm

```bash

npm install react-ipfs

```

### yarn

```bash

yarn add react-ipfs

```

## Documentation

IPFS core documentation is [here](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)

## Usage

src/index.tsx

```js

import { IPFSProvider } from "react-ipfs"

....

    LOADING>}>

      

    

...

```

src/App.tsx

```js

import { useIPFS } from "react-ipfs";

function App() {

  const ipfs = useIPFS()

  useEffect(()=>{

      ipfs.id().then(console.log);

  },[])

...

```

## Contribute

Please see the [contributing guidelines](./CONTRIBUTING.md)