OwlPort-Desktop

This is the GUI interface for OwlNest, powered by Tauri and Vue.

Work In Progress

The GUI and the library it is using(OwlNest) is still in early stage of development, you will experience bugs and even memory leaks. Feel free to file an issue if something is wrong! It is also a way to keep the project churning.

Build from source

You will need Rust toolchain installed on your machine to compile the code. Use rustup to bootstrap the Rust toolchain.

Recommended IDE Setup

• VS Code + Volar + Tauri + rust-analyzer
• If you want to share your experience when with other IDE setups, please file a PR.

For Windows

Prerequisite: vcpkg for linking openssl

• Clone https://github.com/Microsoft/vcpkg and execute bootstrap-vcpkg.bat inside the cloned repository.
• Set environment variable VCPKG_ROOT to the cloned repository.
  • Optional: Append the path to the repository to your PATH environment variable so that you can use it directly in your terminal.
  • Don't use the vcpkg that is bundled with Visual Studio, it's only intended for use with existing vcpkg projects. This repository does not contain a vcpkg project.
  • Your IDE might need a restart to access the newly-set environment variable.
  • You can use echo $Env:VCPKG_ROOT to see whether the variable is properly set(only works with PowerShell).
• Execute ./vcpkg.exe install openssl:x64-windows-static-md to install openssl library that can be statically-linked.

Note: You can also use dynamically linked openssl. Please refer to crate openssl documentation for more info. Note: You can also use vendored feature to compile OpenSSL library from source, without external copy of OpenSSL. This will increase time taken on first-time build and build after cleaning build artifacts. You will also need a Perl installation to compile OpenSSL from source.

Prerequisite: protoc

We use Protocol Buffers for efficient encoding of binary data and thus require protoc to be installed.

• Using downloaded binary: see Protocol Buffers official website.
• Using Chocolatey: choco install protoc.

Prerequetie: NodeJS for frontend build

• Get the latest LTS version of NodeJS from its official website. Non-LTS or older version may work, but there is no guarantee.
• Alternatively, install nvm for managing all NodeJS installations on your machine using Chocolatey with choco install nvm. Note that normal NodeJS installation will ask if you want to use Chocolately as your package manager for installing node modules with native code(C/C++).

Prerequestie: WebView2

• Tauri needs WebView2 to render the UI properly. Windows 10 Update 1809 and later should have WebView2 installed by default. If you are building on an older OS you can get WebView 2 here(English page).

For Linux

Prerequesties: webkit2gtk and common build tools

• Similar to Windows, Tauri needs a browser engine to render the UI properly, which is webkit2gtk in this case.
• Please refer to official documentation of Tauri for more information to setup for developing Tauri applications.

Bodyless development

Bodyless mode is selected(or rather, body-full mode is deselected) when execute yarn vite without bringing up tauri CLI(nor Rust toolchain) first. In this mode, all calls through tauri IPC from frontend code will result in error. In this mode, all errors relates to IPC calls is suppressed.