Skip to content

Commit 6e7dc08

Browse files
committed
Readme updates.
1 parent 91f09c2 commit 6e7dc08

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,23 @@ Currently we have the plugin configured so it can be translated and the followin
104104
* sv_SE - Swedish in Sweden (thanks to [Sebastian Johnsson](http://www.agiley.se/) for contributing)
105105
* tr_TR - Turkish in Turkey (thanks to [Hakan E.](http://kazancexpert.com/) for contributing)
106106

107+
## E2E tests
108+
The `tests` directory contains end-to-end tests for the project, utilizing Cypress to run tests in an environment created using wp-env.
109+
110+
### Pre-requisites
111+
- Node.js v20
112+
- Docker
113+
- Create an account in [Mailchimp](https://mailchimp.com/)
114+
115+
### Run E2E tests in local
116+
1. Run `npm install`.
117+
2. Run `npm run build`.
118+
3. Run `npm run env:start`.
119+
4. Set Mailchimp credentials as environment variables:
120+
- run `export CYPRESS_MAILCHIMP_USERNAME="your mailchimp username"`
121+
- run `export CYPRESS_MAILCHIMP_PASSWORD="your mailchimp password"`
122+
5. Run `npm run cypress:run`. You can also run `npm run cypress:open` to run tests in UI mode.
123+
107124
## Support Level
108125

109126
**Active:** Mailchimp is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

0 commit comments

Comments
 (0)