Skip to main content

Development Guide

8/22/25About 1 min

Development Guide

Development Requirements

System Dependencies

  • sqlite3: Required for database operations
  • bzip2: Required for compression functionality

Development

yarn install
yarn tauri dev

Build

Windows

Prerequisites

  1. Install Visual Studio 2022 with:

    • "Desktop development with C++" workload
    • Windows SDK (10.0.22621.0 or later)
    • MSVC v143 - VS 2022 C++ x64/x86 build tools
    • For ARM64 builds: "MSVC v143 - VS 2022 C++ ARM64 build tools"

  2. Install Node.js and Yarn

    # Install yarn if not already installed
npm install -g yarn

  3. Install Rust

    # Install from https://rustup.rs/
rustup target add x86_64-pc-windows-msvc  # For x64 builds
rustup target add aarch64-pc-windows-msvc # For ARM64 builds

  4. Install Dependencies

    # Install project dependencies
yarn install

  5. Install and Configure vcpkg

    # Clone and bootstrap vcpkg
git clone https://github.com/microsoft/vcpkg
cd vcpkg
.\bootstrap-vcpkg.bat

# Install required libraries
# For x64 builds:
.\vcpkg install sqlite3:x64-windows-static-md
.\vcpkg install bzip2:x64-windows-static-md

# For ARM64 builds:
.\vcpkg install sqlite3:arm64-windows-static-md
.\vcpkg install bzip2:arm64-windows-static-md

Building

Option 1: Using automated build script (Recommended)

# This will automatically set up the environment and build
.\build.bat

Option 2: Manual build

# First, set up environment variables
.\setup-env.ps1  # PowerShell script (Recommended)
# or
.\setup-env.bat  # Batch script (For compatibility)

# Then build
yarn tauri build

The build output will be located in src-tauri/target/release/.

Note: The environment setup needs to be done each time you open a new command prompt window, as the environment variables are only valid for the current session.

Linux

Prerequisites

# Install system dependencies (for Debian/Ubuntu)
sudo apt-get update
sudo apt-get install -y \
  build-essential \
  pkg-config \
  libssl-dev \
  libgtk-3-dev \
  libwebkit2gtk-4.1-dev \
  libayatana-appindicator3-dev \
  librsvg2-dev \
  libsoup-3.0-dev \
  libbz2-dev \
  libsqlite3-dev

# Install Node.js and Yarn
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
npm install -g yarn

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Building

# Install dependencies
yarn install

# Build
yarn tauri build

macOS

Prerequisites

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install system dependencies
brew install node
brew install yarn
brew install sqlite3

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Building

# Install dependencies
yarn install

# Build without bundle
yarn tauri build --no-bundle

# Bundle for distribution outside the macOS App Store
yarn tauri bundle --bundles app,dmg