Skip to content

Commit 452b2f9

Browse files
Rewrote the README as the new quickstart guide
1 parent 41537b8 commit 452b2f9

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,39 @@
1-
# Applitools Tutorial - Selenium Java - Ultrafast Grid
1+
# Applitools Tutorial: Selenium Java JUnit with the Ultrafast Grid
22

3-
Get started with Applitools Eyes visual testing with this Ultrafast Grid example of using the [Selenium](https://www.selenium.dev/documentation/en/), Java, and the [Eyes Selenium Java SDK](https://applitools.com/docs/api/eyes-sdk/index-gen/class-eyes-selenium-java.html) to run tests in the Applitools cloud.
3+
This is the example project for the [Selenium Java JUnit tutorial](https://applitools.com/tutorials/selenium-java.html).
4+
It shows how to start automating visual tests
5+
with [Applitools Eyes](https://applitools.com/platform/eyes/)
6+
and the [Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/)
7+
using [Selenium WebDriver](https://www.selenium.dev/) in Java.
48

5-
Learn more about how to install and start this project with our [Selenium Java tutorial](https://applitools.com/tutorials/selenium-java.html)!
9+
It uses:
610

7-
<https://applitools.com/tutorials/selenium-java.html>
11+
* [Java](https://www.java.com/) as the programming language
12+
* [Selenium WebDriver](https://www.selenium.dev/) for browser automation
13+
* [Google Chrome](https://www.google.com/chrome/downloads/) as the local browser for testing
14+
* [Apache Maven](https://maven.apache.org/index.html) for dependency management
15+
* [JUnit 5](https://junit.org/junit5/) as the core test framework
16+
* [Applitools Eyes](https://applitools.com/platform/eyes/) for visual testing
17+
* [Applitools Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) for cross-browser execution
818

9-
## More Information
19+
To run this example project, you'll need:
1020

11-
Learn more about Applitools [Eyes](https://info.applitools.com/ucY77) and the [Ultrafast Test Cloud](https://info.applitools.com/ucY78) at [applitools.com](https://info.applitools.com/ucY76).
21+
1. An [Applitools account](https://auth.applitools.com/users/register), which you can register for free.
22+
2. The [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/downloads/), version 8 or higher.
23+
3. A good Java editor, such as [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/).
24+
4. [Apache Maven](https://maven.apache.org/download.cgi) (typically bundled with IDEs).
25+
5. An up-to-date version of [Google Chrome](https://www.google.com/chrome/downloads/).
26+
6. A corresponding version of [ChromeDriver](https://chromedriver.chromium.org/downloads).
1227

13-
More about the Eyes Selenium Java SDK:
14-
* https://applitools.com/docs/api/eyes-sdk/index-gen/class-eyes-selenium-java.html
28+
The main test case is [`AcmeBankTests.java`](src/test/java/com/applitools/example/AcmeBankTests.java).
29+
30+
To execute tests, set the `APPLITOOLS_API_KEY` environment variable
31+
to your [account's API key](https://applitools.com/tutorials/getting-started/setting-up-your-environment.html),
32+
and then run:
33+
34+
```
35+
mvn test
36+
```
37+
38+
**For full instructions on running this project, take our
39+
[Selenium Java JUnit tutorial](https://applitools.com/tutorials/selenium-java.html)!**

0 commit comments

Comments
 (0)