@getalby/lightning-messageboard
v1.1.0
Published
A web component for a lightning messageboard powered by NWC
Readme
Lightning Messageboard
A simple messageboard web component powered by NWC that allows visitors to pay bitcoin to post messages.
Demo
The demo shows various themes and customization options for the Lightning Messageboard component.
Screenshots
Features
- 💸 Lightning Network payment integration via Nostr Wallet Connect (NWC)
- 🎨 Customizable themes
- 🔒 Secure receive-only connection to your wallet
- 📱 Responsive design
- 💬 Simple but effective comments system for your website
- 🎮 Visitors can pay more to ensure their comment shows at the top of the message board
Usage
Include the script:
<script
type="module"
src="https://esm.sh/@getalby/lightning-messageboard"
></script>Then add the web component where you want it to be displayed:
<lightning-messageboard
nwc-url="nostr+walletconnect://..."
></lightning-messageboard>Attributes
Required
nwc-url: NWC connection secret of a sub-wallet with receive-only permissions (make_invoice, lookup_invoice, list_transactions) for receiving Lightning Network payments.
Optional
theme: JSON string with theme colors.
Theme Options
The following theme properties can be customized:
primary-color: Main color used for buttons and accentsbackground-color: Background color of the componentborder-color: Color for borderstext-color: Main text colortext-muted-color: Color for secondary textbutton-text-color: Text color for buttonsborder-radius: Border radius for the component and elements
See the demo for example themes and use your browser dev tools to inspect them.
Development
Clone the repository and install dependencies:
git clone https://github.com/getAlby/lightning-messageboard.git
cd lightning-messageboard
yarn installBuild the project:
yarn buildStart a HTTP server to view the demo page locally:
python3 -m http.serverLicense
MIT
