{"id":15153075,"url":"https://github.com/akashaorg/ipfs-connector","last_synced_at":"2025-09-30T01:32:16.030Z","repository":{"id":57095931,"uuid":"58755383","full_name":"AKASHAorg/ipfs-connector","owner":"AKASHAorg","description":"AKASHA \u003c---\u003e IPFS connector","archived":true,"fork":false,"pushed_at":"2020-09-12T11:15:26.000Z","size":1651,"stargazers_count":106,"open_issues_count":9,"forks_count":23,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-12-17T10:45:10.807Z","etag":null,"topics":["akasha","data-structures","ipfs","ipfs-connector","js-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AKASHAorg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-13T16:21:26.000Z","updated_at":"2024-08-13T00:46:07.000Z","dependencies_parsed_at":"2022-08-22T23:10:17.499Z","dependency_job_id":null,"html_url":"https://github.com/AKASHAorg/ipfs-connector","commit_stats":null,"previous_names":["akashaproject/ipfs-connector"],"tags_count":122,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AKASHAorg%2Fipfs-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AKASHAorg%2Fipfs-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AKASHAorg%2Fipfs-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AKASHAorg%2Fipfs-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AKASHAorg","download_url":"https://codeload.github.com/AKASHAorg/ipfs-connector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234687175,"owners_count":18871707,"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":["akasha","data-structures","ipfs","ipfs-connector","js-api"],"created_at":"2024-09-26T17:00:25.363Z","updated_at":"2025-09-30T01:32:15.703Z","avatar_url":"https://github.com/AKASHAorg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ipfs-connector\n[![Build Status](https://travis-ci.org/AkashaProject/ipfs-connector.svg?branch=master)](https://travis-ci.org/AkashaProject/ipfs-connector)\n[![Coverage Status](https://coveralls.io/repos/github/AkashaProject/ipfs-connector/badge.svg?branch=master)](https://coveralls.io/github/AkashaProject/ipfs-connector?branch=master)\n[![npm](https://img.shields.io/npm/dm/@akashaproject/ipfs-connector.svg)](https://www.npmjs.com/package/@akashaproject/ipfs-connector)\n[![Known Vulnerabilities](https://snyk.io/test/github/akashaproject/ipfs-connector/badge.svg)](https://snyk.io/test/github/akashaproject/ipfs-connector)\n\nLibrary for solving the cross-platform binaries problem (works on Windows as well) containing helpers for easier read/write on IPFS by extending the [JavaScript IPFS API](https://github.com/ipfs/js-ipfs-api) functionality.\n\nSome of the differences:\n\n- Able to specify init folder\n- Promised based, no callbacks \n- Connector can be accessed from anywhere inside the app as it is a singleton\n- Plug your favorite logging library (by default console). See [tests folder](https://github.com/AkashaProject/ipfs-connector/tree/master/tests)\n\nFor more information please see the [API docs](http://docs.akasha.world/ipfs-connector/index.html)\n\n### Installation\n```\nnpm install @akashaproject/ipfs-connector --save\n```\n\n### Usage\n```javascript\nimport { IpfsConnector } from '@akashaproject/ipfs-connector';\n\nconst instance = IpfsConnector.getInstance();\n\n// start ipfs daemon and download binaries if needed\ninstance.start().then((api) =\u003e {});\n\n// stop daemon\ninstance.stop()\n\n// see api docs\n// add/get data to ipfs\n// cid zdpuB2CAUgUbyJ4s8SmqcGGaGfs7bG337dDNty8NSCR3fhgRw\nconst cid = instance.api.add({firstName: 'John', lastName: 'Doe'});\n//returns John\ninstance.api.get(cid, '/firstName'); \n\n// read data from ipfs\ninstance.api.ipfsApi.cat('ipfs hash')\n\n// access default ipfs-http-api from\ninstance.api.ipfsApi\n```\n### Dev\n```\ngit clone https://github.com/AkashaProject/ipfs-connector.git\ncd ipfs-connector\n\n// install dependencies\nnpm install\n\n// run tests\nnpm test\n\n// generate docs\nnpm run docs\n```\n[CHANGELOG](CHANGELOG.md)\n\n[LICENSE](LICENSE.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashaorg%2Fipfs-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakashaorg%2Fipfs-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashaorg%2Fipfs-connector/lists"}