{"id":23039138,"url":"https://github.com/shop3/workbox-ipfs","last_synced_at":"2025-04-02T23:46:07.448Z","repository":{"id":65526042,"uuid":"516383031","full_name":"shop3/workbox-ipfs","owner":"shop3","description":"IPFS router for a Workbox service worker.","archived":false,"fork":false,"pushed_at":"2023-03-03T01:27:57.000Z","size":4203,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-08T14:12:45.165Z","etag":null,"topics":["ipfs","workbox"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shop3.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-21T13:28:54.000Z","updated_at":"2023-06-18T22:11:23.000Z","dependencies_parsed_at":"2024-12-15T18:39:55.534Z","dependency_job_id":null,"html_url":"https://github.com/shop3/workbox-ipfs","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.2142857142857143,"last_synced_commit":"aeb96da623b24c391755d2224a2e67973d18e617"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shop3%2Fworkbox-ipfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shop3%2Fworkbox-ipfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shop3%2Fworkbox-ipfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shop3%2Fworkbox-ipfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shop3","download_url":"https://codeload.github.com/shop3/workbox-ipfs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246911488,"owners_count":20853654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ipfs","workbox"],"created_at":"2024-12-15T18:28:16.809Z","updated_at":"2025-04-02T23:46:07.409Z","avatar_url":"https://github.com/shop3.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Workbox IPFS\n\nIPFS router for a Workbox service worker.\n\n## Table of content\n- [How does it work](#how-does-it-work)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Install Dev Environment](#install-dev-environment)\n- [Run Dev Application](#run-dev-application)\n\n## How does it work\n\nOnce installed and initialized the IPFS router intercept and reply to IPFS urls and paths.\n\nValid requests are:\n- IPFS paths: `/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu`\n- IPNS paths: `/ipns/github.com`\n- IPFS urls: `https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu`\n- IPNS urls: `https://ipfs.io/ipns/github.com`\n\n## Installation\n\n```bash\nnpm install --save workbox-ipfs\n```\n\n## Usage\n\nIn the workbox service worker:\n\n```js\nimport { initialize } from 'workbox-ipfs';\n\ninitialize({\n  /* IPFS Options */\n})\n```\n\nOn the web page:\n\n```js\nconst response = await fetch('/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu');\nconst file = await response.blob();\n```\n\n## Install Dev Environment\n\n```bash\nnpm install\n\nnpm run husky:install\n```\n\n## Run Dev Application\n\n```bash\nnpm run develop\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshop3%2Fworkbox-ipfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshop3%2Fworkbox-ipfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshop3%2Fworkbox-ipfs/lists"}