TREZOR SUITE MONOREPO

Welcome to the Trezor Suite repository! This repository contains the source code for 3 projects:

• Connect - tool that offers developers an easy way to integrate Trezor's functionality into their own applications
• Trezor Suite - desktop and web application for managing Trezor hardware wallet
• Trezor Suite Lite - Mobile application designed for tracking user portfolios

Development

Development is not possible on Windows. This can be circumvented by tools such as WSL, see our guide.

Prerequisities

• NVM
• Yarn
• Git LFS (For Linux/Ubuntu, after adding the repository do sudo apt-get install git-lfs, more info here)

Getting started

• git clone git@github.com:trezor/trezor-suite.git
• cd trezor-suite
• git submodule update --init --recursive
• git lfs install // Set up Git LFS for your user account. You only need to run this once per user account.
• git lfs pull
• nvm install
• yarn
• yarn build:libs

It's recommended to enable git config --global submodule.recurse true so you don't need to run git submodule update --init --recursive every time when submodules are updated.

You don't need a Trezor device to get into the app, you can use emulator. There is a Trezor User Env to help you set it up and run emulator for any Trezor model 🎉

Connect @trezor/connect

This repository is used for development of version 9 of @trezor/connect. For detailed documentation, please refer to this page.

Historically, Trezor Connect had its own repository. This repository is now archived.

Trezor Suite @trezor/suite

Run a dev build:

• yarn suite:dev (web app)
• yarn suite:dev:desktop (electron app)

Trezor Suite Lite @suite-native/app

To set up your dev environment for a native platform (iOS/Android) follow these additional steps.

Contribute

Inspired by GitLab Contributing Guide

Using Conventional Commits is required.

Security vulnerability disclosure

Please report suspected security vulnerabilities in private to security@satoshilabs.com, also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.

IDE specific settings

Find specific settings for Integrated Development Environments (IDE) in IDE.md