Skip to content

Commit

Permalink
🎨 chore: Added missing steps to run example (#1096)
Browse files Browse the repository at this point in the history
* 🎨 chore: Added missing steps to run example

* ✏️ chore: typo

---------

Co-authored-by: drptbl <[email protected]>
  • Loading branch information
matstyler and drptbl authored Feb 5, 2024
1 parent d3734d8 commit 2990269
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions examples/new-dawn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@
# 📖 Intro

The New Dawn version of Synpress differs in one major way from all previous versions and all other similar Web3 tools:
- We set up the browser only once, and we cache it. Thanks to this, tests not only run faster, but it also allows to use **ALL FEATURES** of [Playwright](https://playwright.dev/), such as parallel testing 🚀

You can define how a browser should be set up yourself. You can find setup file examples [here](./test/wallet-setup). All setup files must have the following naming structure: `*.setup.{js,ts}`.
- We set up the browser only once, and we cache it. Thanks to this, tests not only run faster, but it also allows to use
**ALL FEATURES** of [Playwright](https://playwright.dev/), such as parallel testing 🚀

Once you define a setup file, you can build a cache with our CLI. By default, the cache is built in a headed mode and utilizes the setup files from `test/wallet-setup` directory.
You can define how a browser should be set up yourself. You can find setup file examples [here](./test/wallet-setup).
All setup files must have the following naming structure: `*.setup.{js,ts}`.

Once you define a setup file, you can build a cache with our CLI. By default, the cache is built in a headed mode and
utilizes the setup files from `test/wallet-setup` directory.
Try running it with the `--help` flag to see all available configuration options.

Here's how to use it:

```bash
# Build cache in a headed mode:
synpress
Expand All @@ -26,16 +31,29 @@ synpress --headless
# 🧑‍💻 Usage

1. Install dependencies:

```bash
pnpm install
```

2. Start MetaMask Test Dapp:

```bash
pnpm run serve:test-dapp
```

3. Build cache with our CLI by using a script:
3. Install Playwright:

```bash
pnpm exec playwright install
```

*3a. If you do not have Anvil installed, go to
the [Foundry installation guide](https://book.getfoundry.sh/getting-started/installation#installation)* and follow the
instructions.

4. Build cache with our CLI by using a script:

```bash
# You can either build cache in a headed mode:
pnpm run build:cache
Expand All @@ -44,7 +62,8 @@ pnpm run build:cache
pnpm run build:cache:headless
```

4. Run Playwright tests as you would normally do:
5. Run Playwright tests as you would normally do:

```bash
# Use one of our scripts:
pnpm run test:e2e:headful
Expand Down

0 comments on commit 2990269

Please sign in to comment.