Development Guide

Development Requirements

System Dependencies

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

Development

yarninstallyarn 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 installednpminstall-gyarn

  3. Install Rust

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

  4. Install Dependencies

    # Install project dependenciesyarninstall

  5. Install and Configure vcpkg

    # Clone and bootstrap vcpkggit clone https://github.com/microsoft/vcpkgcdvcpkg.\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 buildyarn 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)sudoapt-get updatesudoapt-getinstall-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 Yarncurl-fsSL https://deb.nodesource.com/setup_lts.x |sudo-Ebash -sudoapt-getinstall-y nodejsnpminstall-gyarn# Install Rustcurl--proto'=https'--tlsv1.2-sSf https://sh.rustup.rs |sh

Building

# Install dependenciesyarninstall# Buildyarn 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 dependenciesbrew installnodebrew installyarnbrew install sqlite3# Install Rustcurl--proto'=https'--tlsv1.2-sSf https://sh.rustup.rs |sh

Building

# Install dependenciesyarninstall# Build without bundleyarn tauri build --no-bundle# Bundle for distribution outside the macOS App Storeyarn tauri bundle --bundles app,dmg