WebChat/README.md

61 lines
3 KiB
Markdown
Raw Normal View History

2024-09-27 07:39:52 +00:00
<p align="center">
2024-09-27 07:42:26 +00:00
<img src="https://github.com/molvqingtai/WebChat/blob/master/src/public/logo.png" width="200px"/>
2024-09-27 07:39:52 +00:00
</p>
2023-07-11 20:22:57 +00:00
2024-09-27 07:39:52 +00:00
# WebChat
2024-09-27 07:32:20 +00:00
2024-10-09 10:54:46 +00:00
[![GitHub License](https://img.shields.io/github/license/molvqingtai/WebChat)](https://github.com/molvqingtai/WebChat/blob/master/LICENSE) [![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/cpaedhbidlpnbdfegakhiamfpndhjpgf)](https://chromewebstore.google.com/detail/webchat/cpaedhbidlpnbdfegakhiamfpndhjpgf) [![GitHub Release](https://img.shields.io/github/v/release/molvqingtai/WebChat)](https://github.com/molvqingtai/WebChat/releases)
2024-09-27 07:39:52 +00:00
> Chat with anyone on any website
2024-09-27 07:32:20 +00:00
2024-09-27 07:39:52 +00:00
This is an anonymous chat browser extension that is decentralized and serverless, utilizing WebRTC for end-to-end encrypted communication. It prioritizes privacy, with all data stored locally.
2024-09-27 07:32:20 +00:00
2024-10-12 04:08:07 +00:00
The aim is to add chat room functionality to any website, you'll never feel alone again.
2024-09-27 07:32:20 +00:00
2024-10-01 16:30:24 +00:00
### Install
2024-10-09 10:54:46 +00:00
**Install from Store**
2024-10-09 10:57:13 +00:00
- [Chrome Web Store](https://chromewebstore.google.com/detail/webchat/cpaedhbidlpnbdfegakhiamfpndhjpgf)
2024-10-14 13:53:27 +00:00
- [Edge Web Store](https://microsoftedge.microsoft.com/addons/detail/mmfdplbomjjlgdffecapcpgjmhfhmiob)
2024-10-30 02:25:45 +00:00
- [Firefox Addons](https://addons.mozilla.org/firefox/addon/webchat/)
2024-10-09 10:54:46 +00:00
**Manual Installation**
2024-10-01 16:30:24 +00:00
1. Go to the GitHub repository ([Releases](https://github.com/molvqingtai/WebChat/releases))
2. Click on the "Assets" button and select "web-chat-\*.zip"
3. Extract the ZIP file to a folder on your computer
4. Open the extension management page in your browser (usually chrome://extensions/)
- Enable "Developer mode"
- Click "Load unpacked" and select the folder you just extracted
2024-10-12 04:08:07 +00:00
### Use
2024-10-12 04:13:38 +00:00
After installing the extension, you'll see a ghost icon in the bottom-right corner of any website. Click it, and you'll be able to chat happily with others on the same site!
2024-10-12 04:08:07 +00:00
2024-09-28 10:28:46 +00:00
### Video
2024-09-27 07:42:26 +00:00
2024-09-28 10:47:51 +00:00
https://github.com/user-attachments/assets/34890975-5926-4e38-9a5f-34a28e17ff36
2024-09-27 07:32:20 +00:00
### Standing on the Shoulders of Giants
2024-09-30 13:43:02 +00:00
In addition to the good idea of decentralized chat, it also leverages some fantastic technologies.
2024-09-27 07:32:20 +00:00
2024-09-28 11:21:36 +00:00
- **[remesh](https://github.com/remesh-js/remesh)**: A framework in JavaScript that implements DDD principles, achieving true separation of UI and logic, allowing for easy implementation of the UI part, such as rewriting it in Vue, due to its independence from the UI.
2024-09-27 07:32:20 +00:00
2024-09-28 08:23:44 +00:00
- **[shadcn/ui](https://ui.shadcn.com/)**: A beautiful UI library and a pioneer of the no-install concept, offering unmatched convenience in customizing styles.
2024-09-27 07:32:20 +00:00
2024-09-28 08:23:44 +00:00
- **[wxt](https://wxt.dev/)**: This is the best framework Ive used for building browser extensions, bar none.
2024-09-27 07:32:20 +00:00
2024-09-28 08:23:44 +00:00
- **[trystero](https://github.com/dmotz/trystero)**: The core dependency for implementing decentralized communication, enabling connections to decentralized networks like IPFS, torrent, Nostr, etc.
2023-07-13 17:54:56 +00:00
2024-09-28 11:20:21 +00:00
- **[ugly-avatar](https://github.com/txstc55/ugly-avatar)**: Use it to create stunning random avatars.
2023-07-13 17:54:56 +00:00
### License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/molvqingtai/WebChat/blob/master/LICENSE) file for details