Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 2.85 KB

README.md

File metadata and controls

97 lines (60 loc) · 2.85 KB
Raw

@trezor/suite-desktop

Build target for Trezor Suite desktop application.

Official download page

The @trezor/suite-desktop package now serves as a container for the generated/bundled code from the UI and Electron layers, and is responsible for creating the Electron app. No custom code should be added to this package, and no dependencies from the monorepo should be added to the package.json in @trezor/suite-desktop. Doing so would break this system.

Both dependencies and devDependencies defined in package.json of this package are taken as "external" and copied into bundle without other processing.

Development

yarn workspace @trezor/suite-desktop dev

Read more about development and debugging

Build

Prerequisites:

yarn && yarn build:libs

Linux

yarn workspace @trezor/suite-desktop build:linux
chmod u+x ./packages/suite-desktop/build-electron/Trezor-Suite[version].AppImage
./packages/suite-desktop/build-electron/Trezor-Suite[version].AppImage

Note: On Debian, CentOS and similar distributions you might need to add a --no-sandbox flag

MacOS

yarn workspace @trezor/suite-desktop build:mac

Go to ./packages/suite-desktop/build-electron/mac and open the app

or start the app from terminal:

./packages/suite-desktop/build-electron/mac/Trezor\ Suite.app/Contents/MacOS/Trezor\ Suite

Windows

yarn workspace @trezor/suite-desktop build:win

Go to ./packages/suite-desktop/build-electron and install the app

NixOS

Note: To run TrezorSuite.AppImage you need appimage-run package. nix-env -iA nixos.appimage-run

yarn workspace @trezor/suite-desktop build:linux
appimage-run ./packages/suite-desktop/build-electron/Trezor-Suite[version].AppImage

Note: If build fails on a missing cache file (.cache/**/mksquashfsthis) additionally run ./nixos-fix-binaries.sh script and repeat build step.

User data dir

Location of data directory depends on platform:

Platform User data dir path
linux /home/<user>/.config/
macOS ~/Library/Application Support/
Windows C:\Users\<user>\AppData\Roaming\

Name of data directory depends on environment and it's @trezor/suite-desktop, @trezor/suite-desktop-dev or @trezor/suite-desktop-local.

You can open current user data dir directly in Suite debug settings via the link in "Wipe app data" description.

Remove IndexedDB from local machine

To remove a database, delete following folder:

<user data dir>/IndexedDB

Clearing Electron cache

To clear electron cache, delete following folder:

<user data dir>/Cache