-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,8 @@ | ||
# WalletConnect v2.x.x | ||
# WalletConnect Legacy (v1.0) | ||
|
||
Open protocol for connecting Wallets to Dapps - https://walletconnect.com | ||
|
||
## Setup development | ||
|
||
The following dependencies are required for relay server: | ||
|
||
- git | ||
- make | ||
- docker version 20.10 | ||
|
||
To setup the local redis and relay server you can run: | ||
|
||
```sh | ||
make dev | ||
``` | ||
|
||
## Test Client | ||
|
||
Client unit tests can be run against: local (`make dev`), staging, and production server | ||
|
||
```sh | ||
# local (dev) | ||
make test-client | ||
|
||
# staging server | ||
make test-staging | ||
|
||
# production server | ||
make test-production | ||
``` | ||
|
||
## Additional help | ||
|
||
``` | ||
bootstrap-lerna setups lerna for the monorepo management | ||
build-container builds relay docker image | ||
build-lerna builds the npm packages in "./packages" | ||
build-nginx builds nginx docker image | ||
build builds docker images | ||
clean-all cleans lerna bootstrap | ||
clean removes all build outputs | ||
cloudflare setups cloudflare API token secret | ||
config configures domain and certbot email | ||
deploy-monitoring same as deploy but also has monitoring stack | ||
deploy deploys production stack with './config' file contents | ||
dev runs relay on watch mode and shows logs | ||
help Show this help | ||
pull downloads docker images | ||
redeploy redeploys the prodution containers and rebuilds them | ||
relay-logs follows the relay container logs. Doesn't work with 'make dev' | ||
reset removes config and lerna bootstrap | ||
rm-redis stops the redis container | ||
start-redis starts redis docker container for local development | ||
stop stops the whole docker stack | ||
test-relay runs "./servers/relay" tests against the locally running relay. Make sure you run 'make dev' before. | ||
test-client runs "./packages/sign-client" tests against the locally running relay. Make sure you run 'make dev' before. | ||
test-production tests client against relay.walletconnect.com | ||
test-staging tests client against staging.walletconnect.com | ||
``` | ||
Monorepo for WalletConnect (v1.0) legacy JS packages | ||
|
||
**NOTE:** These v1.0 packages are published to NPM be used in parallel with v2.0 packages avoiding dependency conflicts | ||
## License | ||
|
||
Apache 2.0 |