ChatterGun is a cutting-edge web component that enables real-time, decentralized chat functionality in your web applications. Powered by GunDB, ChatterGun offers a robust, scalable solution for integrating chat systems that prioritize privacy and data sovereignty.
ChatterGun is a cutting-edge web component that enables real-time, decentralized chat functionality in your web applications. Powered by GunDB, ChatterGun offers a robust, scalable solution for integrating chat systems that prioritize privacy and data sovereignty.
ChatterGun can be included directly from a CDN or installed via npm:
Simply include the following <script>
tag in your HTML to start using ChatterGun:
<script src="https://cdn.jsdelivr.net/npm/[email protected]/index.js"></script>
Install ChatterGun using npm or yarn:
npm install @valiantlynx/chattergun
# or
yarn add @valiantlynx/chattergun
After installation, you can import ChatterGun in your JavaScript project:
import '@valiantlynx/chattergun';
Once included in your project, you can add ChatterGun to your web page like any other HTML element:
<chat-app></chat-app>
You can customize ChatterGun using CSS variables for themes or directly manipulate the shadow DOM for more complex customizations.
chat-app {
--chat-background-color: #f0f0f0;
--chat-text-color: #333;
--chat-button-color: #007bff;
}
To configure ChatterGun, set properties directly on the element:
<chat-app peer-list="https://yourcustomrelay.com/gun"></chat-app>
If you prefer to build ChatterGun from the source, clone the repository and run:
npm install
npm run build
This will compile the source files into a distributable format in the dist
folder.
Contributions are welcome! Please see our GitHub repository for submitting issues or pull requests.
ChatterGun is open-sourced software licensed under the MIT license.
For more details and documentation, please visit our official website or the GitHub repository.