/yoroi-frontend

React frontend for the Yoroi Chrome extension

Primary LanguageJavaScriptMIT LicenseMIT

Yoroi - Cardano ADA wallet

Contributing

Check out our documents on the governance of this project.

First-time setup (or branch change)

SETUP.md

TOOLS.md

Build Yoroi Chrome extension

Extension can be built for both the Cardano mainnet and testnet:

  • Localhost (recommended)
# build files to './dev'
$ npm run dev
  • Mainnet
# build files to './build'
$ npm run build -- --env "mainnet"
  • Testnet
# build files to './build'
$ npm run build -- --env "testnet"

Run Yoroi Chrome extension

  1. Open new webpage with chrome://extensions
  2. Turn on the developer mode (checkbox in the top right-hand corner)
  3. Press Load unpacked
  4. Select either dev or build folder (depending which npm command you ran)

Note: dev should hot reload on code change

Build release candidate

RELEASE.md

Test

# flow
$ npm run flow
# lint
$ npm run eslint
# features (command to run all existing tests)
$ npm run test-e2e
# How to run one .feature file (One feature file = one covered component from youtrack)
$ npm run test-by-feature feature/wallet-creation.feature
# How to run one test. Instead of '@it-10' you can use any tag from youtrack
$ npm run test-by-tag @it-10

Update Cardano crypto library

In order to update it run the following commands:

# Update js-cardano-wasm
cd js-cardano-wasm;
git checkout master;
git pull origin master;
cd ..;

# Commit the update
git add .
git commit -S -m "${youCommitMessage}"
git push ...

# Re-install the module
$ npm run build-js-cardano-wasm 
$ npm install

# At this point you can go back to Development steps.

LICENSE

MIT