Custom IPLD repo

How to customize a IPLD formats


Explore the docs · View Demo · Report Bug · Request Feature/Example

Table of Contents

• Table of Contents
• About The Project
• Getting Started
  • Prerequisites
  • Installation and Running example
• Usage
  • Play with the configuration!
• References
• Documentation
• Contributing
• Want to hack on IPFS?

About The Project

• Read the docs
• Look into other examples to learn how to spawn an IPFS node in Node.js and in the Browser
• Consult 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
• See https://blog.ipfs.io for news and more
• Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io

Getting Started

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• Node.js - Download & Install Node.js and the npm package manager.

Installation and Running example

> npm install
> npm start

Usage

This example shows you how to configure an IPFS daemon with the ability to load extra IPLD formats so you can use them in your applications.

Play with the configuration!

By default, IPFS is only configured to support a few common IPLD formats. Your application may require extra or more esoteric formats, in which case you can configure your node to support them using options.ipld.formats passed to the client or an in-process node or even a daemon if you start it with a wrapper.

See the following files for different configuration:

• ./in-process-node.js for running an in-process node as part of your configuration
• ./daemon-node.js for running a node as a separate daemon process

For more examples, please refer to the Documentation

References

• Documentation:
  • IPFS CONFIG
  • MISCELLANEOUS
  • DAG
  • IPFS-HTTP-CLIENT CONFIG
  • DAEMON
  • MULTIFORMATS
  • IPLD
• Tutorials:
  • Merkle DAGs

Documentation

• Config
• Core API
• Examples
• Development
• Tutorials

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the IPFS Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -a -m 'feat: add some amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

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