@keyringnetwork/web-component v1.0.2
About The Project
Simply sign the challenge with your preferred wallet provider and you are ready to chat! If you got an ENS name for your wallet, it will be used on behalf of your wallet address. Chats are ephemeral, not logged or stored anywhere. Due to the decentralised nature of the tool, the content posted by users cannot be subject to moderation. The chat supports all UTF-8 characters and is language-agnostic. For security reasons you cannot use BBCode or HTML code, any spurious tag will be stripped out.
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
In order to build this package you will need NodeJS and Yarn installed on your machine.
Installation and local testing
- Clone the repo
git clone https://github.com/Keyring-Network/keyring-web-component.git - Install required packages both in the base and the example folder using the same command
yarn install - Execute the demo app
yarn start
Usage
This plugin works with Ethereum mainnet and Rinkeby testnet only.
To use this package in your (d)app simply:
1. install it with yarn add @keyring-web-component
2. import it locally using import Chatbox from "keyring-web-component"
3. instantiate the component passing the required params <Chatbox provider={injectedProvider} address={address} streamID={STREAM_ID} theme="#backgroundColorHex />
The component needs the following parameters to work:
- provider: web3 provider (MetaMask, WalletConnect, Web3Modal, ...)
- address: (the user address in hexadecimal form as a string)
- theme: the background colour in hex format (default: #0360a5)
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the GPL-3.0+ License. See LICENSE for more information.
Contact
Project Link: https://github.com/Keyring-Network/keyring-web-component