grfullerton / trezor-suite Goto Github PK

View Code? Open in Web Editor NEW

:candy: Trezor Suite Monorepo

License: Other

JavaScript 3.18% Java 0.91% Objective-C 0.12% TypeScript 94.70% HTML 0.35% Dockerfile 0.13% CSS 0.22% Shell 0.25% Ruby 0.02% Starlark 0.04% Nix 0.04% C 0.01% Roff 0.02%

trezor-suite's Introduction

TREZOR SUITE MONOREPO

Packages

Name	Packages
suite	core, web, desktop, native, data, storage
components	components, storybook native
rollout	rollout
blockchain-link	blockchain-link
translations-manager	translations-manager
integration-tests	integration-tests

Development

Before you start make sure you have downloaded and installed Node.js LTS, Yarn and git.

git clone [email protected]:trezor/trezor-suite.git
yarn

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

Run a dev build:

yarn suite:dev (web app)
yarn suite:dev:desktop (electron app)
yarn suite:dev:android (react-native Android)
yarn suite:dev:ios (react-native iOS)

Contribute

Inspired by GitLab Contributing Guide

Using Conventional Commits is strongly recommended and might be enforced in future.

Security vulnerability disclosure

Please report suspected security vulnerabilities in private to [email protected], also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.

Issue Labels

Priority

Label	Meaning (SLA)
P1 Urgent	The current release + potentially immediate hotfix (30 days)
P2 High	The next release (60 days)
P3 Medium	Within the next 3 releases (90 days)
P4 Low	Anything outside the next 3 releases (120 days)

Severity

Label	Impact
S1 Blocker	Outage, broken feature with no workaround
S2 Critical	Broken feature, workaround too complex & unacceptable
S3 Major	Broken feature, workaround acceptable
S4 Low	Functionality inconvenience or cosmetic issue