diff --git a/README.md b/README.md index 5db7f45..589d4aa 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,48 @@ # Pre-requisites: -1. Java, Maven, IntelliJ IDEA (or Eclipse) installed on your machine. +1. Java is installed on your machine. + * [Install JDK](https://www.oracle.com/java/technologies/javase-downloads.html) - * [Install Maven](https://maven.apache.org/install.html) - * [Install IntelliJ IDEA](https://www.jetbrains.com/idea/download/) or [Install Eclipse](https://www.eclipse.org/downloads/) -2. Chrome Webdriver is on your machine and is in the PATH. Here are some resources from the internet that'll help you. + +2. Maven is installed on your machine, JAVA_HOME environment variable is created, added to PATH, path to Maven is added to PATH too + + * [Install Maven, configure enviroment variables](https://maven.apache.org/install.html) + +3. Chrome Webdriver is on your machine and is in the PATH. Here are some resources from the internet that'll help you. + * https://splinter.readthedocs.io/en/0.1/setup-chrome.html * https://stackoverflow.com/questions/38081021/using-selenium-on-mac-chrome * https://www.youtube.com/watch?time_continue=182&v=dz59GsdvUF8 +4. IntelliJ IDEA (or Eclipse) is installed on your machine if you want to run example from IDE. + + * [Install IntelliJ IDEA](https://www.jetbrains.com/idea/download/) or [Install Eclipse](https://www.eclipse.org/downloads/) + + + # Steps to run this example 1. Git clone this repo + + * `git clone https://github.com/applitools/tutorial-selenium-java-ultrafastgrid.git`, or download [this as a Zip file](https://github.com/applitools/tutorial-selenium-java-ultrafastgrid/archive/master.zip) and unzip it + +2. Navigate to just cloned folder tutorial-selenium-java-basic. + +3. Get an API key by logging into Applitools > Person Icon > My API Key + +4. Open in any editor file src\test\java\com\applitools\quickstarts\AppTest.java and set your ApiKey in string 'config.setApiKey("...")' (or comment the string and set APPLITOOLS_API_KEY environment variable) + +5. Run 'mvn -Dtest=AppTest test'. + +6. If you want to run example from IDE perform next steps: + + 6.1. Import the project as a *Maven* project in IntelliJ IDEA or Eclipse. + + 6.2 Set Project SDK to your JDK (installed in Pre-requisites) in Intellij - File > Project Structure > Project. + + 6.3 Run or Debug class AppTest or method test(). -`git clone https://github.com/applitools/tutorial-selenium-java-ultrafastgrid.git` + -2. Import the project as a *Maven* project in Eclipse or IntelliJ. -3. Set your API key in the _APPLITOOLS_API_KEY_ env variable. Get an API key by logging into Applitools > Person Icon > My API Key -4. Run 'mvn -Dtest=AppTest test' or click the 'Run' button in Eclipse/IntelliJ +Read more here: https://www.applitools.com/tutorials/selenium-java.html -Read more here: https://www.applitools.com/tutorials/selenium-java.html \ No newline at end of file