diff --git a/README.md b/README.md index 6be5a5d0..5f686ab4 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,32 @@ ## Mobile Test Framework [![Codacy Badge](https://app.codacy.com/project/badge/Grade/8958948e2b0048a785417344e0dffe43)](https://www.codacy.com/gh/dipjyotimetia/MobileTestFramework/dashboard?utm_source=github.com&utm_medium=referral&utm_content=dipjyotimetia/MobileTestFramework&utm_campaign=Badge_Grade) -![CI](https://github.com/dipjyotimetia/MobileTestFramework/workflows/CI/badge.svg) +![CI](https://github.com/dipjyotimetia/MobileTestFramework/workflows/CI/badge.svg) + ### Full-fledged Mobile, API and Database framework using appium and rest-assured -### Supported Platforms -Appium Studio supports app automation across a variety of platforms, like iOS,Android, from Windows platform. Each platform is supported by one or more "drivers", -which know how to automate that particular platform. Choose a driver below for specific information about how that driver works and how to set it up: +### Supported Platforms + +Appium Studio supports app automation across a variety of platforms, like iOS,Android, from Windows platform. Each +platform is supported by one or more "drivers", which know how to automate that particular platform. Choose a driver +below for specific information about how that driver works and how to set it up: * Android * The [UiAutomator2 Driver](/docs/en/drivers/android-uiautomator2.md) * IOS - * The [XCUITest](http://appium.io/docs/en/drivers/ios-xcuitest/) - + * The [XCUITest](http://appium.io/docs/en/drivers/ios-xcuitest/) + ### Why [Appium](http://appium.io/docs/en/about-appium/intro/)? -* Appium is an Open source automation tool used for cross platform testing like native, hybrid and web applications on both the platforms IOS and Android. - Its capability for testing all kinds of tools under one platform, makes it a multipurpose and convenient testing tool.Appium is called as a cross platform - testing tool because it uses JSON wire protocol internally to interact with native apps of IOS and Android using Selenium Webdriver. + +* Appium is an Open source automation tool used for cross platform testing like native, hybrid and web applications on + both the platforms IOS and Android. Its capability for testing all kinds of tools under one platform, makes it a + multipurpose and convenient testing tool.Appium is called as a cross platform testing tool because it uses JSON wire + protocol internally to interact with native apps of IOS and Android using Selenium Webdriver. ### Setup & Tools + * Download and install [Nodejs](https://nodejs.org/en/download/) `` npm install -g appium @@ -28,13 +34,14 @@ which know how to automate that particular platform. Choose a driver below for s `` npm install -g appium-doctor `` - verify all appium dependencies -* [Download Appium Desktop](https://github.com/appium/appium-desktop/releases) download latest release + verify all appium dependencies +* [Download Appium Desktop](https://github.com/appium/appium-desktop/releases) download the latest release * [Install InteliJ Community Edition](https://www.jetbrains.com/idea/download/) -* [Java JDK_8](https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html) install jdk_8 version +* [Java JDK_11](https://adoptopenjdk.net/) install jdk_11 version * [Gradle](https://gradle.org/next-steps/?version=6.7.1&format=bin) -* [Allure](https://github.com/allure-framework/allure2/archive/2.13.8.zip) -* Set Environment variables +* [Allure](https://github.com/allure-framework/allure2/archive/2.14.0.zip) +* Set the below environment variables + ```shell * JAVA_HOME: Pointing to the Java SDK folder\bin * GRADLE_HOME: Pointing to Gradle directory\bin. @@ -42,13 +49,17 @@ which know how to automate that particular platform. Choose a driver below for s * APPIUM_HOME: Pointing appium main.js from global location. * NODE_HOME: Pointing nodejs installation. ``` + * For more details navigate to the above [Wiki Page](https://github.com/dipjyotimetia/MobileTestFramework/wiki) ### Connect - Local Devices: + Connect an Android and an iOS Device using a USB cable to your PC - - Follow documentation for device connection + +- Follow documentation for device connection ### Getting Started + ```shell $ git clone $ cd @@ -59,14 +70,18 @@ $ gradle task E2E $ gradle allureReport $ gradle allureServe ``` + ### Execution Gif -![browserstack](https://github.com/dipjyotimetia/MobileTestFramework/blob/master/docs/gif/gif_android.mp4) -![browserstack](https://github.com/dipjyotimetia/MobileTestFramework/blob/master/docs/gif/gif_ios.mp4) + +![browserstack](https://github.com/dipjyotimetia/MobileTestFramework/blob/master/docs/gif/gif_android.gif) +![browserstack](https://github.com/dipjyotimetia/MobileTestFramework/blob/master/docs/gif/gif_ios.gif) ### Write your first user journey + Create new class and name as the TC00*_E2E_TEST-*** - - Provide jira link in @Link - - Provide all the api components as @Feature - - Provide test severity and description - - Write test - - Use CatchBlock in try/catch section + +- Provide jira link in @Link +- Provide all the api components as @Feature +- Provide test severity and description +- Write test +- Use CatchBlock in try/catch section diff --git a/docs/gif/gif_android.gif b/docs/gif/gif_android.gif new file mode 100644 index 00000000..7e908d6d Binary files /dev/null and b/docs/gif/gif_android.gif differ diff --git a/docs/gif/gif_android.mp4 b/docs/gif/gif_android.mp4 deleted file mode 100644 index f410b470..00000000 Binary files a/docs/gif/gif_android.mp4 and /dev/null differ diff --git a/docs/gif/gif_ios.gif b/docs/gif/gif_ios.gif new file mode 100644 index 00000000..d0b27c30 Binary files /dev/null and b/docs/gif/gif_ios.gif differ diff --git a/docs/gif/gif_ios.mp4 b/docs/gif/gif_ios.mp4 deleted file mode 100644 index 7f8395fc..00000000 Binary files a/docs/gif/gif_ios.mp4 and /dev/null differ diff --git a/docs/gif/videogif.gif b/docs/gif/videogif.gif deleted file mode 100644 index d1239b93..00000000 Binary files a/docs/gif/videogif.gif and /dev/null differ