Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.38 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.38 KB
Raw

WalletConnect v2.x.x

Open protocol for connecting Wallets to Dapps - https://walletconnect.com

Setup

  1. Ensure nodejs and npm
  2. Clone the repository
  3. Install all package dependencies, by running npm install from the root folder

Running checks for all packages

To ensure all packages lint, build and test correctly, we can run the following command from the root folder:

For tests to pass in the following command, you will need your own TEST_PROJECT_ID value, which will be generated for you when you set up a new project on WalletConnect Cloud.

TEST_PROJECT_ID=YOUR_PROJECT_ID npm run check

Command Overview

  • clean - Removes build folders from all packages
  • lint - Runs eslint checks
  • prettier - Runs prettier checks
  • build - Builds all packages
  • test - Tests all packages
  • check - Shorthand to run lint, build and test commands
  • reset - Shorthand to run clean and check commands

Troubleshooting

  1. If you are experiencing issues with installation ensure you install npm i -g node-gyp
  2. You will need to have xcode command line tools installed
  3. If there are issues with xcode command line tools try running
sudo xcode-select --switch /Library/Developer/CommandLineTools
sudo xcode-select --reset

License

Apache 2.0