mirror of
https://github.com/trezor/trezor-suite.git
synced 2026-03-09 16:58:32 +01:00
900246c337
Trezor Suite has Nix configuration to develop and build web, desktop and mobile app but we lacked the documentation for that.
116 lines
2.2 KiB
Markdown
116 lines
2.2 KiB
Markdown
# Nix
|
|
|
|
Trezor Suite provides two ways to use Nix: a **Nix flake** (`flake.nix`) and a **`shell.nix`** for environments without flakes enabled.
|
|
|
|
## Prerequisites
|
|
|
|
### Flakes
|
|
|
|
- [Nix](https://nixos.org/download) installed with flakes enabled
|
|
- Add `experimental-features = nix-command flakes` to `~/.config/nix/nix.conf`
|
|
|
|
### shell.nix
|
|
|
|
- [Nix](https://nixos.org/download) installed (no extra config needed)
|
|
|
|
---
|
|
|
|
## Flake: Available Dev Shells
|
|
|
|
### Default shell (web/desktop development)
|
|
|
|
Includes Node.js 24, Yarn, Playwright, Electron, and all build dependencies.
|
|
|
|
```bash
|
|
nix develop
|
|
# or explicitly:
|
|
nix develop .#default
|
|
```
|
|
|
|
### Android shell (mobile development)
|
|
|
|
Includes everything in the default shell plus:
|
|
|
|
- Java (JDK)
|
|
- Android SDK (platforms, build tools, NDK)
|
|
- Android Emulator with system images
|
|
- A default AVD is auto-created on first run
|
|
|
|
```bash
|
|
nix develop .#android
|
|
```
|
|
|
|
## Common Workflows
|
|
|
|
### Web / Desktop development
|
|
|
|
```bash
|
|
nix develop
|
|
yarn
|
|
yarn suite:dev # Web app at http://localhost:8000
|
|
yarn suite:dev:desktop # Electron desktop app
|
|
```
|
|
|
|
### Mobile (Android) development
|
|
|
|
```bash
|
|
nix develop .#android
|
|
yarn
|
|
yarn native:start # Start Metro bundler (in one terminal)
|
|
yarn a # Run on Android (in another terminal)
|
|
```
|
|
|
|
### Running the Android emulator
|
|
|
|
```bash
|
|
nix develop .#android
|
|
# list available AVDs with:
|
|
avdmanager list avd
|
|
emulator -avd <avd-name>
|
|
emulator -avd Pixel_3a_API_31
|
|
```
|
|
|
|
If you have troubles with your GPU acceleration you can disable it when running emulator like:
|
|
|
|
```bash
|
|
emulator -avd Pixel_3a_API_31 -gpu swiftshader_indirect
|
|
```
|
|
|
|
### Running tests
|
|
|
|
```bash
|
|
nix develop
|
|
yarn test:unit
|
|
yarn nx:test-unit # Only affected packages
|
|
```
|
|
|
|
---
|
|
|
|
## shell.nix
|
|
|
|
For environments without flakes, use `nix-shell` with the root [shell.nix](../shell.nix).
|
|
|
|
### Default (web/desktop)
|
|
|
|
```bash
|
|
nix-shell
|
|
```
|
|
|
|
### Android
|
|
|
|
Pass `USE_ANDROID=1` to include the Android SDK, JDK, and emulator:
|
|
|
|
```bash
|
|
USE_ANDROID=1 nix-shell
|
|
```
|
|
|
|
### Bluetooth transport development
|
|
|
|
The [packages/transport-bluetooth](../packages/transport-bluetooth/) package has its own shell with a Rust toolchain:
|
|
|
|
```bash
|
|
nix-shell packages/transport-bluetooth/shell.nix
|
|
```
|
|
|
|
---
|