https://github.com/alanshaw/chatterbox-webext

🧭 A p2p messaging application built on IPFS and libp2p
https://github.com/alanshaw/chatterbox-webext

chat im ipfs libp2p libp2p-pubsub messaging p2p snapchat twitter

Last synced: about 1 month ago
JSON representation

🧭 A p2p messaging application built on IPFS and libp2p

• Host: GitHub
• URL: https://github.com/alanshaw/chatterbox-webext
• Owner: alanshaw
• License: mit
• Created: 2019-09-30T14:38:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-31T12:44:14.000Z (9 months ago)
• Last Synced: 2025-03-28T08:02:01.639Z (2 months ago)
• Topics: chat, im, ipfs, libp2p, libp2p-pubsub, messaging, p2p, snapchat, twitter
• Language: JavaScript
• Homepage:
• Size: 497 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Chatterbox Web Extension

[![dependencies Status](https://david-dm.org/alanshaw/chatterbox-core/status.svg)](https://david-dm.org/alanshaw/chatterbox-webext)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

> P2P messaging application bundled as a web extension for Firefox and Chrome

## Install

|  [Firefox](https://www.mozilla.org/firefox/new/) |  [Chrome](https://www.google.com/chrome/)

|---|---|

| [![Install From AMO](https://ipfs.io/ipfs/QmWNa64XjA78QvK3zG2593bSMizkDXXcubDHjnRDYUivqt)](https://addons.mozilla.org/firefox/addon/chatterbox/) | [![Install from Chrome Store](https://ipfs.io/ipfs/QmXeTTMAxJVSZLqNcVzBdsAZKhWUpP7w7QAZ8f3Bnmk3Mj)](https://chrome.google.com/webstore/detail/chatterbox/ajomkahbmnpohccinnahekchplpfaejg) |

### Install for Development

Ensure Node.js 12+ and npm 6+ are installed.

1. Clone this repo

2. Install the project dependencies with `npm install`

3. Build the project `npm run build` (see [build](#build) below)

4. Load the web extension in your favourite browser:

    * **Firefox**

        1. Navigate to `about:debugging#/runtime/this-firefox`

        2. Click on the "Load temporary add-on" button

        3. Select `manifest.json` file in the `dist` directory

    * **Chrome**

        1. Navigate to `chrome://extensions`

        2. Click on the "Load unpacked" button

        3. Navigate to the `dist` directory

#### Build

Build with `CHATTERBOX_RELAY_ADDRS` environment variable to specify one or more comma separated multiaddrs of chatterbox relay servers to connect to.

e.g.

```sh

CHATTERBOX_RELAY_ADDRS=/ip4/138.68.55.103/tcp/4138/ws/ipfs/QmTtZnqydWPKxRDuDLbMjo4NHJPwrascKgxQwpBSx5Zd7k npm run build

```

Current production relay addrs:

* `/ip4/138.68.55.103/tcp/4138/ws/ipfs/QmTtZnqydWPKxRDuDLbMjo4NHJPwrascKgxQwpBSx5Zd7k`

#### Package

To package for web extension stores, run the following commands:

1. Build the extension (as above) including any relay addrs

2. Run `npm run package`

3. Output can be found in the `web-ext-artifacts` directory

## Contribute

Feel free to dive in! [Open an issue](https://github.com/alanshaw/chatterbox-webext/issues/new) or submit PRs.

## License

[MIT](LICENSE) © Alan Shaw