Skip to content

Commit

Permalink
fix(DIST-589): Update README
Browse files Browse the repository at this point in the history
Use "fix" in commit message to trigger release Github Actions workflow.
  • Loading branch information
Matej Lednicky committed Jan 7, 2021
1 parent 1332e87 commit 3798ca6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 17 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,26 @@ To work with Embed as a developer:
yarn clean # delete directories with built files (./dist and ./lib)
```

## Tests

In order to run visual tests, you need an applitools key.

- Add a `.env` file in your root, you can look at the `.env.example`
- Add your api key `EYES_API_KEY=HERE_GOES_YOUR_KEY`
- (Optional) You can add the url, by default the url is `http://localhost:8080`
- Start the server `yarn start`
- Run the tests with `yarn test`
- - This command will run all the tests. That means **unit tests**, **integration tests** and **visual tests**

This is the list of all the test commands, if you want to run them one by one:

```
yarn lint # Run eslint and prettier check
yarn test:unit # Runs unit tests
yarn test:functional # Runs functional tests with Cypress
yarn test:visual # Runs visual tests with Cypress and Applitools
```

## Development suggestions

<!-- TODO: add any "wishlist" items you hope someone might develop -->
Expand Down
17 changes: 0 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,23 +229,6 @@ Although we have no hard limit, we recommend having a height of at least 350px.

We use `position: fixed` to position our modal relative to its containing block established by the viewport. If one of the modal ancestors has a `transform`, `perspective`, or `filter` css property set to something other than `none` the positioning will be relative to it and probably not visible by the user.

## Tests

In order to run visual tests, you need an applitools key.

- Add a `.env` file in your root, you can look at the `.env.example`
- Add your api key `EYES_API_KEY=HERE_GOES_YOUR_KEY`
- (Optional) You can add the url, by default the url is `http://localhost:8080`
- Start the server `yarn start`
- Run the tests with `yarn test`
- - This command will run all the tests. That means **unit tests**, **integration tests** and **visual tests**

This is the list of all the test commands, if you want to run them one by one:

- `yarn test:unit` --> Runs unit tests
- `yarn test:functional` --> Runs functional tests with Cypress
- `yarn test:visual` --> Runs visual tests with Cypress and Applitools

## Feedback

We are always open to your [feedback](https://tfproductops.typeform.com/to/RGpsdc).
Expand Down

0 comments on commit 3798ca6

Please sign in to comment.