diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/Advanced-installation.asciidoc b/mrchecker-docs/documentation/MrChecker-download/Windows/Advanced-installation.asciidoc index 8e30fd37..7bc2d35b 100644 --- a/mrchecker-docs/documentation/MrChecker-download/Windows/Advanced-installation.asciidoc +++ b/mrchecker-docs/documentation/MrChecker-download/Windows/Advanced-installation.asciidoc @@ -17,8 +17,8 @@ toc::[] :source-highlighter: rouge :listing-caption: Listing - == Java installation + There is one important pre-requisite for Mr Checker installation - Java has to be installed on the computer and an environmental variable has to be set in order to obtain optimal functioning of the framework. 1. Install Java 11 JDK 64bit @@ -40,40 +40,95 @@ image::images/install_win03.png[] ---- == Other components installation + Install each component separately, or update the existing ones on your PC. 1. Maven 3.5 or higher - * https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.0/apache-maven-3.5.0-bin.zip[Download Maven] - * Unzip Maven in following location C:\maven - * Set Windows Local Environment - - *Variable name*: M2_HOME | *Variable value*: C:\maven\apache-maven-3.5.0 - - *Variable name*: PATH | *Variable value*: %M2_HOME%\bin +* https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.0/apache-maven-3.5.0-bin.zip[Download Maven] +* Unzip Maven in following location C:\maven +* Set Windows Local Environment +- *Variable name*: M2_HOME | *Variable value*: C:\maven\apache-maven-3.5.0 +- *Variable name*: PATH | *Variable value*: %M2_HOME%\bin + image::images/install_win04.png[] + - * Verify it in the command line: +* Verify it in the command line: + ---- > mvn --version ---- 2. IDE - * Download a most recent https://www.eclipse.org/downloads/packages/[Eclipse] - * Download one of MrChecker Project https://github.com/devonfw/mrchecker/tree/develop/[examples] to get better understanding what we are capable of. - * You should consider installing some useful plugins such as: csvedit, cucumber editor. +* Download a most recent https://www.jetbrains.com/idea/download/?section=windows/[IntelliJ IDEA] +* Download one of MrChecker Project https://github.com/devonfw/mrchecker/tree/develop/[examples] to get better understanding what we are capable of. +* You should consider installing some useful plugins such as: csvedit, cucumber editor. + +=== Import project -* Import: +To import a MrChecker project into IntelliJ IDEA, follow these steps: + +1. Open IntelliJ IDEA and select "File" -> "Open" from the menu. + -image::images/install_win05.png[] +image::images/intellij_1.png[] + - * Projects from folders +2. Navigate to the project path and select the root folder of the MrChecker project. +Click "OK" to proceed. + -image::images/install_win06.png[] +image::images/intellij_2.png[] + - * Open already created projects: + +Your MrChecker project is now ready for development. + -image::images/install_win07.png[] +image::images/intellij_3.png[] + +=== Project from Existing Sources + +To create a new standalone MrChecker project and customize its configuration using example you have to follow this process: + +==== Initial Step: Choose Example and Move to a Separate Folder + +1. Open your file explorer and navigate to the location of the MrChecker examples. + +2. Choose one of the examples that you want to use as a template for your new project. + +3. Create a new folder for your project and move the selected example into this folder. + +When you have the example in the separated folder, which you want to use as the project template you can move to the following steps: + +1. Open IntelliJ IDEA and go to "File" -> "New" -> "Project from Existing Sources" + - * Update project structure - _ALT_ + _F5_ +image::images/intellij_4.png[] + -image::images/install_win08.png[] + +2. Navigate to the folder containing your example project and click "OK." ++ +image::images/intellij_5.png[] ++ + +3. Select "Import project from external model" and choose "Maven." Click "Create" ++ +image::images/intellij_6.png[] ++ + +4. After importing, open the `pom.xml` file in the new project. ++ + +4.1. Remove `` tag ++ +4.2. Replace `your.new.groupId`, `your-new-artifactId`, `your-new-version`, `Your New Developer Name`, `your.new.email@example.com`, `Your New Organization`, and `http://your.new.organization.url` with the updated values. ++ +---- + your.new.groupId + your-new-artifactId + your-new-version + + + + Your New Developer Name + your.new.email@example.com + Your New Organization + http://your.new.organization.url + + +---- + diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_1.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_1.png new file mode 100644 index 00000000..95c0341c Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_1.png differ diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_2.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_2.png new file mode 100644 index 00000000..08013581 Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_2.png differ diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_3.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_3.png new file mode 100644 index 00000000..90737223 Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_3.png differ diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_4.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_4.png new file mode 100644 index 00000000..b5818459 Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_4.png differ diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_5.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_5.png new file mode 100644 index 00000000..87ecef6c Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_5.png differ diff --git a/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_6.png b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_6.png new file mode 100644 index 00000000..e8b69917 Binary files /dev/null and b/mrchecker-docs/documentation/MrChecker-download/Windows/images/intellij_6.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/Project-Organization.asciidoc b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/Project-Organization.asciidoc index 6f58c4b5..f6cf44b7 100644 --- a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/Project-Organization.asciidoc +++ b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/Project-Organization.asciidoc @@ -1,63 +1,93 @@ = Project organization -== Importing projects +== Import project -Every MrChecker project should be imported as a Maven Project. +To import a MrChecker project into IntelliJ IDEA, follow these steps: -Example from Eclipse IDE: +1. Open IntelliJ IDEA and select "File" -> "Open" from the menu. ++ +image::images/intellij_1.png[] ++ +2. Navigate to the project path and select the root folder of the MrChecker project. +Click "OK" to proceed. ++ +image::images/intellij_2.png[] ++ -image::images/1.png[] +Your MrChecker project is now ready for development. ++ +image::images/intellij_3.png[] -image::images/2.png[] +== Use example as project template -Enter the project path and select projects to import. +To create a new standalone MrChecker project and customize its configuration using example you have to follow this process: -image::images/3.png[] +=== Initial Step: Choose Example and Move to a Separate Folder -When the import is finished, update the project structure - ALT + F5 +1. Open your file explorer and navigate to the location of the MrChecker examples. -image::images/4.png[] +2. Choose one of the examples that you want to use as a template for your new project. -== Exporting projects +3. Create a new folder for your project and move the selected example into this folder. -In order to create a new standalone MrChecker project, you can use template-app-under-test and export it to the new folder: +When you have the example in the separated folder, which you want to use as the project template you can move to the following steps: -image::images/6.png[] +1. Open IntelliJ IDEA and go to "File" -> "New" -> "Project from Existing Sources" ++ +image::images/intellij_4.png[] ++ -Create a new folder for the project and enter its path. -Select project and files to export: +2. Navigate to the folder containing your example project and click "OK." ++ +image::images/intellij_5.png[] ++ -image::images/7.png[] +3. Select "Import project from external model" and choose "Maven." Click "Create" ++ +image::images/intellij_6.png[] ++ -Change project name and other properties, if necessary, in pom.xml file: +4. After importing, open the `pom.xml` file in the new project. ++ -image::images/8.png[] - -Then you can import the project to the workspace and create new packages and classes. - -== Creating new packages - -1. You will need two new packages: one for the new page classes, the other one for test classes: +4.1. Remove `` tag ++ +4.2. Replace `your.new.groupId`, `your-new-artifactId`, `your-new-version`, `Your New Developer Name`, `your.new.email@example.com`, `Your New Organization`, and `http://your.new.organization.url` with the updated values. ++ +---- + your.new.groupId + your-new-artifactId + your-new-version + + + + Your New Developer Name + your.new.email@example.com + Your New Organization + http://your.new.organization.url + + +---- -* Create a package for page classes +== Creating New Packages -- Open Eclipse -- Use the "Project Explorer" on the left -- Navigate to [your-project] → src/main/java → com.capgemini.mrchecker → selenium -- Right-click on "selenium" -- Click on "New" → New Package -- Name the new package "com.capgemini.mrchecker.selenium.pages.[your-product-name]" +To organize your MrChecker project, you will need two new packages: one for the new page classes and the other for test classes. -* Create a package for test classes +* Create a package for page classes: -- Navigate to [your-project] → src/test/java → com.capgemini.mrchecker → selenium -- Right click on "selenium" -- Click on "New" → New Package -- Name the new package "com.capgemini.mrchecker.selenium.tests.[your-product-name]" +- Open IntelliJ IDEA. +- Use the "Project" tool window on the left. +- Navigate to [your-project] -> src -> main -> java -> com.capgemini.mrchecker -> selenium. +- Right-click on "selenium." +- Choose "New" -> "Package." +- Name the new package "com.capgemini.mrchecker.selenium.pages.[your-product-name]." -Example: +* Create a package for test classes: -image::images/9.png[] +- Navigate to [your-project] -> src -> test -> java -> com.capgemini.mrchecker -> selenium. +- Right-click on "selenium." +- Choose "New" -> "Package." +- Name the new package "com.capgemini.mrchecker.selenium.tests.[your-product-name]." == Creating new Page Classes diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_1.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_1.png new file mode 100644 index 00000000..95c0341c Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_1.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_2.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_2.png new file mode 100644 index 00000000..08013581 Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_2.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_3.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_3.png new file mode 100644 index 00000000..90737223 Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_3.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_4.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_4.png new file mode 100644 index 00000000..b5818459 Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_4.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_5.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_5.png new file mode 100644 index 00000000..87ecef6c Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_5.png differ diff --git a/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_6.png b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_6.png new file mode 100644 index 00000000..e8b69917 Binary files /dev/null and b/mrchecker-docs/documentation/Who-Is-MrChecker/Tutorials/images/intellij_6.png differ