From 32e5db38d0736eb31df6f2929eb07b109337c8a4 Mon Sep 17 00:00:00 2001 From: aahna-ashina <95955389+aahna-ashina@users.noreply.github.com> Date: Fri, 22 Jul 2022 11:30:14 +0800 Subject: [PATCH] test: add cypress commands to readme --- .github/workflows/ui_goerli.yml | 1 + .github/workflows/ui_mainnet.yml | 1 + README.md | 32 +-------------------- ui/README.md | 49 ++++++++++++++++++++++++++++++++ 4 files changed, 52 insertions(+), 31 deletions(-) create mode 100644 ui/README.md diff --git a/.github/workflows/ui_goerli.yml b/.github/workflows/ui_goerli.yml index 94e66c7a7..b308010ce 100644 --- a/.github/workflows/ui_goerli.yml +++ b/.github/workflows/ui_goerli.yml @@ -34,3 +34,4 @@ jobs: - run: yarn install - run: yarn build - run: yarn lint + - run: yarn cypress:headless diff --git a/.github/workflows/ui_mainnet.yml b/.github/workflows/ui_mainnet.yml index 302097384..4d57be4c3 100644 --- a/.github/workflows/ui_mainnet.yml +++ b/.github/workflows/ui_mainnet.yml @@ -34,3 +34,4 @@ jobs: - run: yarn install - run: yarn build - run: yarn lint + - run: yarn cypress:headless diff --git a/README.md b/README.md index f5782889a..005b31736 100644 --- a/README.md +++ b/README.md @@ -27,37 +27,7 @@ The code in this repository is structured into two main parts: ## Run the UI locally -Navigate to the folder of the UI app: -``` -cd ui/ -``` - -Install the dependencies: -``` -yarn install -``` - -Add variables to your local development environment: -``` -cp .env.mainnet .env.local -``` - -Build: -``` -yarn build -``` - -Lint: -``` -yarn lint -``` - -Start the development server: -``` -yarn dev -``` - -Then open http://localhost:42069 in a browser. +See [ui/README.md](ui/README.md) ## Testing against the Goerli Ethereum testnet diff --git a/ui/README.md b/ui/README.md new file mode 100644 index 000000000..8895f9daf --- /dev/null +++ b/ui/README.md @@ -0,0 +1,49 @@ +# Nation3 App UI + +https://app.nation3.org + +## Run the UI locally + +Navigate to the folder of the UI app: +``` +cd ui/ +``` + +Install the dependencies: +``` +yarn install +``` + +Add variables to your local development environment: +``` +cp .env.mainnet .env.local +``` + +Build: +``` +yarn build +``` + +Lint: +``` +yarn lint +``` + +Start the development server: +``` +yarn dev +``` + +Then open http://localhost:42069 in a browser. + +## Integration Testing + +Run the integration tests: +``` +yarn cypress +``` + +Run the integration tests headlessly: +``` +yarn cypress:headless +```