{"id":14482900,"url":"https://github.com/libp2p/js-libp2p-examples","last_synced_at":"2025-04-05T09:05:16.161Z","repository":{"id":38771585,"uuid":"190261107","full_name":"libp2p/js-libp2p-examples","owner":"libp2p","description":"Examples for the JS implementation of libp2p","archived":false,"fork":false,"pushed_at":"2025-03-19T12:09:05.000Z","size":748,"stargazers_count":88,"open_issues_count":10,"forks_count":53,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-03-29T08:06:31.349Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libp2p.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2019-06-04T18:51:05.000Z","updated_at":"2025-03-24T05:49:03.000Z","dependencies_parsed_at":"2022-09-12T23:50:25.545Z","dependency_job_id":"1ac9f635-35c8-433a-9707-a1d3dab6cb16","html_url":"https://github.com/libp2p/js-libp2p-examples","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libp2p","download_url":"https://codeload.github.com/libp2p/js-libp2p-examples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312077,"owners_count":20918344,"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":[],"created_at":"2024-09-03T00:01:22.069Z","updated_at":"2025-04-05T09:05:16.136Z","avatar_url":"https://github.com/libp2p.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://libp2p.io\"\u003e\n    \u003cimg width=\"250\" src=\"https://github.com/libp2p/js-libp2p/blob/main/img/libp2p.png?raw=true\" alt=\"libp2p hex logo\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eA collection of js-libp2p examples\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png\" width=\"200\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://github.com/libp2p/js-libp2p/tree/master/doc\"\u003eExplore the docs\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/libp2p/js-libp2p-examples/issues\"\u003eReport Bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/libp2p/js-libp2p-examples/issues\"\u003eRequest Feature/Example\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents \u003c!-- omit in toc --\u003e\n\n- [About The Project](#about-the-project)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Understanding how libp2p works](#understanding-how-libp2p-works)\n  - [Other examples](#other-examples)\n- [Contribute](#contribute)\n- [License](#license)\n\n## About The Project\n\n- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)\n- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)\n- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more\n- Read the [libp2p specs](https://github.com/libp2p/specs)\n- See https://blog.libp2p.io for news and more\n- Head over to https://proto.school to take interactive tutorials that cover core libp2p APIs\n- Need help? Visit the discussion board: https://github.com/libp2p/js-libp2p/discussions\n\n## Getting Started\n\nFeel free to jump directly into the examples, however going through the following sections will help build context and background knowledge.\n\n### Prerequisites\n\nMake sure you have installed all of the following prerequisites on your development machine:\n\n- Git - [Download \u0026 Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.\n- Node.js - [Download \u0026 Install Node.js](https://nodejs.org/en/download/) and the npm package manager.\n\n### Understanding how libp2p works\n\n- [Circuit Relay](https://github.com/libp2p/js-libp2p-example-circuit-relay) - configuring Circuit Relay connections\n- [Connection Encryption](https://github.com/libp2p/js-libp2p-example-connection-encryption) - how to encrypt connection between libp2p nodes\n- [Delegated routing](https://github.com/libp2p/js-libp2p-example-delegated-routing) - how to offload network operations and queries onto more capable nodes\n- [Discovery mechanisms](https://github.com/libp2p/js-libp2p-example-discovery-mechanisms) - how libp2p discovers other peers on the network\n- [Custom protocols](https://github.com/libp2p/js-libp2p-example-custom-protocols) - how to create a custom protocol for your application\n- [Transports](https://github.com/libp2p/js-libp2p-example-transports) - how to connect peers together via different transports\n  - [WebRTC](https://github.com/libp2p/js-libp2p-example-webrtc-private-to-private) - a special transport for connecting browsers together\n\n### Other examples\n\nThese are demo apps or examples that showcase specific modules or services:\n\n- [Chat](https://github.com/libp2p/js-libp2p-example-chat) - a simple chat app\n- [Browser Pub/Sub](https://github.com/libp2p/js-libp2p-example-browser-pubsub) - Using Pub/Sub between browsers\n\nThere is also [universal connectivity](https://github.com/libp2p/universal-connectivity/tree/main) demo that shows of how many different libp2p implementations can be connected together.\n\n## Contribute\n\nSee [CONTRIBUTING.md](https://github.com/libp2p/js-libp2p-examples/blob/main/CONTRIBUTING.md).\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-examples/blob/main/LICENSE-APACHE) / \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-examples/blob/main/LICENSE-MIT) / \u003chttp://opensource.org/licenses/MIT\u003e)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibp2p%2Fjs-libp2p-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibp2p%2Fjs-libp2p-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibp2p%2Fjs-libp2p-examples/lists"}