Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Latest commit

 

History

History
113 lines (74 loc) · 3.61 KB

dev-setup.md

File metadata and controls

113 lines (74 loc) · 3.61 KB
Raw

Developer Setup

Tauri and Holochain Prerequisites

Go through the tauri prerequisites.

Install Go

Note: for now on Linux you will need to install patchelf and librsvg2-dev: sudo apt-get install patchelf librsvg2-dev

Install Holochain and lair-keystore globally

Check out .github/workflows/release.yaml to see what holochain and lair-keystore versions are needed for this version of the Launcher.

The commands to install them should look like below, replacing the version numbers with the right ones and [_ARCHITECTURE_] with the architecture of your computer. Run them in the root directory of this repository:

Linux/macOS

mkdir src-tauri/bins

cargo install --version 0.4.2 lair_keystore
LAIR_PATH=$(which lair-keystore)
cp $LAIR_PATH src-tauri/bins/lair-keystore-v0.4.2-x86_64-apple-darwin
cp $LAIR_PATH src-tauri/bins/lair-keystore-v0.4.2-[_ARCHITECTURE_]


cargo install holochain --version 0.2.8-rc.1 --locked --features db-encryption
HOLOCHAIN_PATH=$(which holochain)
cp $HOLOCHAIN_PATH src-tauri/bins/holochain-v0.2.8-rc.1-[_ARCHITECTURE_]


[... install further holochain versions if required]

[_ARCHITECTURE_] is x86_64-apple-darwin on an x86 macOS, aarch64-apple-darwin on an Arm/M1 macOS and unknown-linux-gnu on Linux.

Windows

cargo install --version 0.4.2 lair_keystore
$LkPath = Get-Command lair-keystore | Select-Object -ExpandProperty Definition
Copy-Item $LkPath -Destination src-tauri/bins/lair-keystore-v0.4.2-x86_64-pc-windows-msvc.exe

cargo install holochain --version 0.2.8-rc.1 --locked --features db-encryption
$HcPath = Get-Command holochain | Select-Object -ExpandProperty Definition
Copy-Item $HcPath -Destination src-tauri/bins/holochain-v0.2.8-rc.1-x86_64-pc-windows-msvc.exe

[... install further holochain versions if required]

Install packages

npm install

Compiles and hot-reloads for development

npm run tauri dev

Note: This mode will show different behavior in some cases than running production builds. To get the production build behavior (but thereby sacrificing hot-reloading), run instead:

npm run build:ui
cd src-tauri && cargo run

Note: This script runs without hot-reloading but with the ability to open apps within the Launcher

npm run dev:quasi-prod

Compiles and minifies for production

npm run build

Helper scripts

In the scripts directory there is a publish-apps.js script that will help you to add multiple happs at once to the app store. To do this put multiple .webhapp files in the testing-apps directory and run the script within the nix-shell.

npm run publish:apps

Troubleshooting

If you encounter an error message similar to the one below, please verify that the holochain and lair-keystore files in your src-tauri/bins folder have the correct names and versions.

Important: If you experience this error, you may need to rename your files inside src-tauri/bins to match the ones specified in the error messages.

error: failed to run custom build command for `holochain-launcher v0.11.0 `

Caused by:
  process didn't exit successfully: `/Users/user/Work/launcher/target/debug/build/holochain-launcher-029336fae4a64bb2/build-script-build` (exit status: 1)
  --- stdout
  cargo:rerun-if-env-changed=TAURI_CONFIG
  cargo:rerun-if-changed=tauri.conf.json
  cargo:rustc-cfg=desktop
  cargo:rustc-cfg=dev
  path matching bins/holochain-v0.2.8-rc.1-aarch64-apple-darwin not found.
warning: build failed, waiting for other jobs to finish...