Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ipfs-examples/js-ipfs-custom-libp2p

Example of how to make the JS-IPFS configuration to create a libp2p bundle function
https://github.com/ipfs-examples/js-ipfs-custom-libp2p

Last synced: about 2 months ago
JSON representation

Example of how to make the JS-IPFS configuration to create a libp2p bundle function

Awesome Lists containing this project

README 

        


  

    IPFS in JavaScript logo

  




Custom libp2p





  How to customize a libp2p bundle

  


  


  

  


  Explore the docs

  ·

  View Demo

  ·

  Report Bug

  ·

  Request Feature/Example




## Table of Contents



- [Table of Contents](#table-of-contents)

- [About The Project](#about-the-project)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation and Running example](#installation-and-running-example)

- [Usage](#usage)

  - [Play with the configuration!](#play-with-the-configuration)

- [References](#references)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Want to hack on IPFS?](#want-to-hack-on-ipfs)



## About The Project



- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)

- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser

- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) 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](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.

- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.



### Installation and Running example



```console

> npm install

> npm start

```



## Usage



This example shows you how to make full use of the ipfs configuration to create a libp2p bundle function. As IPFS applications become more complex, their needs for a custom libp2p bundle also grow. Instead of fighting with configuration options, you can use your own libp2p bundle function to get exactly what you need.



### Play with the configuration!



With the metrics for peers and bandwidth stats being logged out, try playing around with the nodes configuration to see what kind of metrics you can get. How many peers are you getting? What does your bandwidth look like?



This is also a good opportunity to explore the various stats that ipfs offers! Not seeing a statistic you think would be useful? We'd love to have you [contribute](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)!



_For more examples, please refer to the [Documentation](#documentation)_



## References



- Documentation:

  - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)

  - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md)

  - [STATS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/STATS.md)

  - [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md)

- Examples:

  - [LIBP2P Examples](https://github.com/libp2p/js-libp2p/tree/master/examples)



## Documentation



- [Config](https://docs.ipfs.io/)

- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)

- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)

- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)

- [Tutorials](https://proto.school)



## 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?



[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)



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](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).



- **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge

- **Look at the [IPFS Roadmap](https://github.com/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](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next