The JavaScript implementation of the IPFS protocol
Upgrading from <=0.40 to 0.48? See the release notes for the list of API changes and the migration guide.
We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of
Getting started
- Look into the examples to learn how to spawn an IPFS node in Node.js and in the Browser
- Read the Core API docs to see what you can do with an IPFS node
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
- Check out https://docs.ipfs.io for tips, how-tos and more
Lead Maintainer
Table of Contents
Install
$ npm install ipfsIf you are planning on using js-ipfs on the command line, install it globally:
$ npm install -g ipfsBrowser CDN
You can load IPFS right in your browser by adding the following to your page using the super fast jsdelivr CDN:
<!-- loading the minified version using jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/ipfs/dist/index.min.js"></script>
<!-- loading the human-readable (not minified) version jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/ipfs/dist/index.min.js"></script>Inserting one of the above lines will make an Ipfs object available in the global namespace:
<script>
async function main () {
const node = await window.Ipfs.create()
// Ready to use!
// See https://github.com/ipfs/js-ipfs#core-api
}
main()
</script>Browser bundle
Learn how to bundle IPFS into your application with webpack, parceljs and browserify in the examples.
Documentation
Getting started & constructor options
Core API
How to run IPFS in various environments
Different topics in detail
Questions?
Need help?
Please ask 'How do I?' questions on https://discuss.ipfs.io
Want to hack on IPFS?
The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
Read the Code of Conduct and JavaScript Contributing Guidelines.
- Check out existing issues The issue list has many that are marked as 'help wanted' or 'difficulty:easy' which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
- Look at the IPFS Roadmap This are the high priority items being worked on right now
- Perform code reviews More eyes will help a. speed the project along b. ensure quality, and c. reduce possible future bugs.
- Add tests. There can never be enough tests.
- Join the Weekly Core Implementations Call it's where everyone discusses what's going on with IPFS and what's next
Packages
List of the main packages that make up the IPFS ecosystem.
This table is generated using the module
package-tablewithpackage-table --data=package-list.json.
License
