README.md

MyIconWallet ·

An Icon web wallet — by the community, for the community.

Developing

Getting Started

To get started, clone the repository, install dependencies then run it locally.

git clone https://github.com/ReliantNode/myiconwallet-react.git
cd myiconwallet-react
yarn
yarn start

SSL in Development

If you want to use a Ledger hardware wallet during development, you will need to use https. You can set an environment variable HTTPS=true when you run yarn start to run the development server in https mode using a self-signed SSL certificate.

HTTPS=true yarn start

Testing

Running tests by default will use the Jest interactive watch mode and only watch changed files.

# Interactive watch mode on changed files only
yarn test

# Interactive watch mode on all files
yarn test --watchAll

# Single run of the full test suite
yarn test --watchAll=false

Formatting

All source code is formatted using the opinionated code formatter Prettier. You can set it up to run in your development environment, but we have also setup a pre-commit hook which will automatically format any git staged files.

Continuous Integration / Continuous Delivery

MyIconWallet is using Netlify for CI/CD meaning that any merges into the master branch are automatically deployed to www.myiconwallet.com. Additionally any pull requests will get an automatically generated deploy preview link. The status of Netlify deploys is visible at app.netlify.com/sites/my-icon-wallet/deploys.

Netlify runs the commands yarn format:check, yarn test --watchAll=false then yarn build. All commands must finish successfully for a successful deploy.

Contributing

MyIconWallet is open to contributions and pull requests from the community. We will try to label good first issues when possible.

MyIconWallet adheres to the Contributor Covenant Code of Conduct.

License

MyIconWallet is licensed under the MIT license.