Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 1.55 KB

DEVELOPMENT.md

File metadata and controls

86 lines (55 loc) · 1.55 KB

Development

Make sure you have setup your environment for React Native.

Installation

  1. Clone the repository
git clone [email protected]:synonymdev/bitkit.git && cd bitkit
  1. Install dependencies
yarn install
  1. Setup iOS or Android dependencies
yarn setup-ios

or

yarn setup-android
  1. Start the project

On iOS Simulator:

yarn ios

On Android Emulator:

yarn android

Testing

Bitkit uses two types of testing: unit and end-to-end (E2E) tests.

Before running tests, you need to install Docker and run bitcoind and the electrum server in regtest mode. You can do this by using the docker-compose.yml file from the docker directory:

cd docker
docker compose up

After that, you are ready to run the tests:

1. Unit tests

yarn test

2. End-to-end (E2E) tests

End-to-end tests are powered by Detox. Currently, only the iOS Simulator is supported.

To build the tests:

yarn e2e:build:ios-release

To run them:

yarn e2e:test:ios-release

Troubleshooting

When running into issues there are a couple things to check.

  • Clean caches & build folders: yarn clean
  • Clean simulator cache (iOS): xcrun simctl erase all
  • Increase emulated device storage (Android): Android Studio -> Virtual Device Manager -> Edit Device -> Show Advanced Settings -> increase RAM, VM heap and Internal Storage sizes