https://github.com/morellexf13/appium-webdriverio

🍭 Appium WebdriverIO Starter Boilerplate for NodeJS with Mocha, test your mobile apps with ease!
https://github.com/morellexf13/appium-webdriverio

appium automation aws in-portfolio mocha nodejs starter-boilerplate webdriverio

Last synced: about 17 hours ago
JSON representation

🍭 Appium WebdriverIO Starter Boilerplate for NodeJS with Mocha, test your mobile apps with ease!

• Host: GitHub
• URL: https://github.com/morellexf13/appium-webdriverio
• Owner: morellexf13
• License: mit
• Created: 2022-06-23T12:51:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-07T19:13:54.000Z (over 1 year ago)
• Last Synced: 2025-01-21T11:39:24.507Z (3 days ago)
• Topics: appium, automation, aws, in-portfolio, mocha, nodejs, starter-boilerplate, webdriverio
• Language: JavaScript
• Homepage:
• Size: 21.4 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


    


    🍭

    


    


    Appium WebdriverIO

    


    


  

  

    


Appium WebdriverIO Starter Boilerplate for NodeJS with Mocha. Test your mobile apps with ease!

    


    


[![Build status](https://img.shields.io/github/actions/workflow/status/morellexf13/appium-webdriverio/build.yml?branch=main&label=%20&logo=github&logoColor=white&style=for-the-badge)](https://github.com/morellexf13/appium-webdriverio/actions/workflows/build.yml)

[![Version](https://img.shields.io/github/v/tag/morellexf13/appium-webdriverio?label=%20&style=for-the-badge)](https://github.com/morellexf13/appium-webdriverio/releases)

[![License](https://img.shields.io/badge/-MIT-f56565.svg?longCache=true&style=for-the-badge)](https://github.com/morellexf13/appium-webdriverio/blob/main/LICENSE)

[![Package Monthly Downloads](https://img.shields.io/npm/dm/appium-webdriverio?label=%20&style=for-the-badge)](https://www.npmjs.com/package/appium-webdriverio)

[![Docs](https://img.shields.io/badge/-Docs-blue.svg?style=for-the-badge)](https://webdriver.io)

  






❗️ This guide is mainly intended to be used as an Android User.

## ✨ Pre-requisites

- Install Node (https://nodejs.org/en/download/)

- Install Java (https://www.java.com/en/)

- Setup `ANDROID_HOME` & `JAVA_HOME`

- Install Android Studio (If you want to test using an emulator)

- In order to get your app selectors I recommend you to install Appium Inspector, it can be found [here](https://github.com/appium/appium-inspector/releases).

  1. Open the application you've just installed.

  2. Type `0.0.0.0` in Remote Host.

  3. Type `4723` in Remote Port.

  4. Type '/wd/hub' in Remote Path.

  5. Configure your "Desired Capabilities":

     There are tons of options but you only need this to start.

     ```json

     {

       "platformName": "Android",

       "appium:platformVersion": "12",

       "appium:deviceName": "Android Emulator",

       "appium:app": "{PATH TO APK OR IPA FILE}",

       "appium:automationName": "UiAutomator2" // Default option

     }

     ```

     Read more about desired capabilities [here](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md).

     

You're almost done, at this point you just need to run Appium Desktop by clicking the "startServer" button and then go to the Appium Inspector application and click the "Start session" button. Now that your session has started you will see your application at the left and elements TREE at the right. Click an element to see the selectors to use in your tests.

Always try to set accessibility ids! 🫡



## 🚀 Install & Run boilerplate

Install it locally and run in easy steps

```

1- cd appium-webdriverio

2- npm install

3- npm test

```

## 📊 Run tests with allure reports

Pre-requisites:

```

brew install allure

```

Generate & Open

```

npm run test-allure

```