Skip to content

KoalaSat/botbox

Repository files navigation

BotBox

Title

A browser extension for bringing consistency to your chaotic relays.

Botbox continuously monitors your inbox and outbox relays:

  • It makes sure all your events are available and following the Outbox Model
  • Allows to scan a big list of relays looking for orphan events you should have received
  • (....WIP)

Browser Support

Chrome and other Chromium browsers (Manifest V3)
Firefox and LibreWolf (Manifest V2)

Installation

Chrome/Edge/Brave

  1. Build the extension: npm run build:chrome
  2. Open chrome://extensions/ (or edge://extensions/, brave://extensions/)
  3. Enable "Developer mode" (toggle in top right)
  4. Click "Load unpacked"
  5. Select the dist-chrome/ directory from the project

Firefox

  1. Build the extension: npm run build:firefox
  2. Open about:debugging#/runtime/this-firefox
  3. Click "Load Temporary Add-on"
  4. Select the dist-firefox/botbox-firefox.xpi file (or any file in dist-firefox/)

Development

Build Commands

# Build for Chrome (Manifest V3)
npm run build:chrome

# Build for Firefox (Manifest V2) 
npm run build:firefox

Prerequisites

  • Node.js 20.19+ or 22.12+ (we recommend using nvm)
  • npm or yarn
  • A NIP-07 compatible browser extension (Alby, nos2x, etc.)

Setup

  1. Clone the repository:
git clone <repository-url>
cd nostr-agenda
  1. Install Node.js 22 (if using nvm):
nvm install 22
nvm use 22
  1. Install dependencies:
npm install
  1. Build the extension:
npm run build

The built extensions will be in the dist-chrome/ and dist-firefox/ directories.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

License

MIT License - see LICENSE file for details

Credits

Built with:

Links

About

A browser extension for bringing consistency to your chaotic relays.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

No releases published

Contributors