Skip to content
WebExtension for Buku
Branch: master
Clone or download

README.md

Bukubrow

Bukubrow is a WebExtension for Buku, a command-line bookmark manager.

A corresponding native host is used to interface with your Buku database. Communication between the host and the browser extension is handled via native messaging.

Prerequisites

  • Buku
  • Bukubrow Host
  • Supported browser: Firefox, Chrome, or Chromium
  • If building the WebExtension:
    • Node
    • Yarn

Installation

Installing the host and registering it with your browser is required to allow the browser extension to talk to Buku.

Install the WebExtension from the relevant addon store.

Alternatively, you can build the WebExtension manually as follows:

  1. Clone the repo.
  2. Run make webext. Your zip file will be located within the ./release/ directory. This zip file is the exact structure expected by all compatible browsers.
  3. Load the extension in your browser. Please refer to the browser documentation.

Contributing

The WebExtension is written in strict TypeScript, utilising React for rendering and Redux with thunks for state management, and makes heavy use of the functional library Purify for ADT-driven data management and enhanced type safety. Yarn is used for dependency management and task running. Data is fetched from the host via native messaging.

You can’t perform that action at this time.