Workbox IPFS

IPFS router for a Workbox service worker.

Table of content

• How does it work
• Installation
• Usage
• Install Dev Environment
• Run Dev Application

How does it work

Once installed and initialized the IPFS router intercept and reply to IPFS urls and paths.

Valid requests are:

• IPFS paths: /ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu
• IPNS paths: /ipns/github.com
• IPFS urls: https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu
• IPNS urls: https://ipfs.io/ipns/github.com

Installation

1npm install --save workbox-ipfs

Usage

In the workbox service worker:

1import { initialize } from 'workbox-ipfs';
2
3initialize({
4  /* IPFS Options */
5})

On the web page:

1const response = await fetch('/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu');
2const file = await response.blob();

Install Dev Environment

1npm install
2
3npm run husky:install

Run Dev Application

1npm run develop