https://github.com/libp2p/js-libp2p-example-chat

An example chat app using libp2p
https://github.com/libp2p/js-libp2p-example-chat

Last synced: about 1 year ago
JSON representation

An example chat app using libp2p

• Host: GitHub
• URL: https://github.com/libp2p/js-libp2p-example-chat
• Owner: libp2p
• License: other
• Created: 2023-10-25T13:22:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-21T14:58:57.000Z (over 1 year ago)
• Last Synced: 2025-04-08T18:51:49.216Z (about 1 year ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @libp2p/example-chat 

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)

[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)

[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-examples.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-examples)

[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-examples/ci.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p-examples/actions/workflows/ci.yml?query=branch%3Amain)

> An example chat app using libp2p

## Table of contents 

- [Setup](#setup)

- [Running](#running)

- [Need help?](#need-help)

- [License](#license)

- [Contribution](#contribution)

## Setup

1. Install example dependencies

    ```console

    $ npm install

    ```

2. Open 2 terminal windows in the `./src` directory.

## Running

1. Run the listener in window 1, `node listener.js`

2. Run the dialer in window 2, `node dialer.js`

3. Wait until the two peers discover each other

4. Type a message in either window and hit *enter*

5. Tell yourself secrets to your hearts content!

## Need help?

- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)

- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)

- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more

- Read the [libp2p specs](https://github.com/libp2p/specs)

- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )

- MIT ([LICENSE-MIT](LICENSE-MIT) / )

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be

dual licensed as above, without any additional terms or conditions.