From 0bafa4c7d518c7745f8cdc0a9c05bbc2aab1a66c Mon Sep 17 00:00:00 2001 From: Matthew Russell Date: Thu, 29 Dec 2022 22:48:04 -0600 Subject: [PATCH] chore: add readmes for token and explorer e2e (#2485) * chore: add readmes for token and explorer e2e * fix: typo fix in explorer readme * fix: typo fix in token readme Co-authored-by: Edd --- apps/explorer-e2e/README.md | 34 ++++++++++++++++++++++++++++++++++ apps/token-e2e/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 apps/explorer-e2e/README.md create mode 100644 apps/token-e2e/README.md diff --git a/apps/explorer-e2e/README.md b/apps/explorer-e2e/README.md new file mode 100644 index 000000000..148c95710 --- /dev/null +++ b/apps/explorer-e2e/README.md @@ -0,0 +1,34 @@ +# Vega Explorer E2E tests + +To run the UI automation tests with Vega Capsule, run: + +```bash +yarn nx run explorer-e2e:e2e +``` + +To open Cypress and run in interactive mode, run: + +```bash +yarn nx run explorer-e2e:e2e --watch +``` + +## Vega Capsule Setup + +The e2e tests run against a locally running instance of the Vega network, managed and controlled by [Vega Capsule](https://github.com/vegaprotocol/vegacapsule). Vega Capsule will: + +- Bootstrap and start up a Vega network +- Start up [Ganache](https://trufflesuite.com/ganache/) for a local Ethereum network +- Install the required Vega smart contracts +- Set up DataNodes with a running GraphQL and REST APIs. + +Refer to the [Vega Capsule readme](https://github.com/vegaprotocol/vegacapsule#readme) for setting up and running Capsule. You will need [Go 1.19 or later](https://go.dev/doc/install) and [Docker](https://docs.docker.com/get-docker/) installed. + +### Troubleshooting + +- You may need to run `vegacapsule nodes unsafe-reset-all` to get a clean network state + +## Vega Wallet Setup + +Start by [downloading the Vega wallet software here](https://github.com/vegaprotocol/vega/releases). + +You can then refer to (or run) `vegacapsule/setup-vegawallet.sh`. This will initialise and configure your wallet to have the correct public keys and network config to run against capsule. diff --git a/apps/token-e2e/README.md b/apps/token-e2e/README.md new file mode 100644 index 000000000..093f4a1b3 --- /dev/null +++ b/apps/token-e2e/README.md @@ -0,0 +1,34 @@ +# Vega token website E2E tests + +To run the UI automation tests with Vega Capsule, run: + +```bash +yarn nx run token-e2e:e2e +``` + +To open Cypress and run in interactive mode, run: + +```bash +yarn nx run token-e2e:e2e --watch +``` + +## Vega Capsule Setup + +The e2e tests run against a locally running instance of the Vega network, managed and controlled by [Vega Capsule](https://github.com/vegaprotocol/vegacapsule). Vega Capsule will: + +- Bootstrap and start up a Vega network +- Start up [Ganache](https://trufflesuite.com/ganache/) for a local Ethereum network +- Install the required Vega smart contracts +- Set up DataNodes with a running GraphQL and REST APIs. + +Refer to the [Vega Capsule readme](https://github.com/vegaprotocol/vegacapsule#readme) for setting up and running Capsule. You will need [Go 1.19 or later](https://go.dev/doc/install) and [Docker](https://docs.docker.com/get-docker/) installed. + +### Troubleshooting + +- You may need to run `vegacapsule nodes unsafe-reset-all` to get a clean network state + +## Vega Wallet Setup + +Start by [downloading the Vega wallet software here](https://github.com/vegaprotocol/vega/releases). + +You can then refer to (or run) `vegacapsule/setup-vegawallet.sh`. This will initialise and configure your wallet to have the correct public keys and network config to run against capsule.