Skip to content

Desktop#

Requirements#

Before you start, you must complete the Clients repository setup instructions.

  • macOS

    • Xcode Command Line Tools
    • Rust
  • Windows (These are available as additional dependencies in the Visual Studio Installer):

    • Visual C++ Build tools
    • Rust
  • Linux:

    • The following packages build-essential libsecret-1-dev libglib2.0-dev
    • Rust

Build native module#

The desktop application relies on a native module written in rust, which needs to be compiled separately.

cd apps/desktop/desktop_native
npm run build

Note: This module needs to be re-built if the native code has changed.

Build Instructions#

Build and run:

cd apps/desktop
npm run electron

Debugging and Testing#

Electron apps have a renderer process, which runs in the Electron window, and the main process, which runs in the background.

The renderer process can be inspected using the Chromium debugger. It should open automatically when the Desktop app opens, or you can open it from the “View” menu.

The main process can be debugged by running the app from a Javascript Debug Terminal in Visual Studio Code and then placing breakpoints in build/main.js.

Biometric Unlock (Native Messaging)#

Instructions for configuring native messaging (communication between the desktop application and browser extension) are located in the Browser section.