README.md

sheikah

A Witnet compatible desktop wallet and smart contracts development environment.

Installation

TODO

Development

This is a Web/Desktop application built with Electron and uses the electron-react-typescript template as its base with a few tweaks.

For developing we recommend you use yarn instead of npm.

Quickstart

# clone the repository
git clone git@github.com:witnet/sheikah.git

# cd into the cloned repository
cd sheikah

# install application dependencies
yarn

# launch development application
yarn dev

Build

To build the application run: yarn build and then yarn start to launch the build.

Formatter

• Verify files are correctly formatted with yarn fmt-verify
• See which format errors exist with yarn fmt
• Repair format errors with (this operation modifies your files!) yarn fmt!

Test

We use Jest for testing. All test commands are a thin wrapper around jest so with any of them you can use Jest's CLI options

# run unit/integration tests
yarn test

# run end-to-end tests
yarn test-e2e

# run all tests
yarn test-all

To run specific tests you can use jest directly:

# run test specified with a pattern or filename
yarn jest my-test #or
yarn jest path/to/my-test.js

# run tests related to changed files based on hg/git (uncommitted files)
yarn jest -o

# run tests related to path/to/fileA.js and path/to/fileB.js
yarn jest --findRelatedTests path/to/fileA.js path/to/fileB.js

# run tests that match this spec name (match against the name in describe or test, basically).
yarn jest -t name-of-spec

# run tests in watch mode
yarn jest --watch #runs jest -o by default
yarn jest --watchAll #runs all tests

Package

To package the application into an executable for your platform (Windows, MacOS, GNU/Linux) run:

yarn package