{"id":24567468,"url":"https://github.com/morellexf13/appium-webdriver","last_synced_at":"2026-04-11T03:33:16.511Z","repository":{"id":39998311,"uuid":"507149459","full_name":"morellexf13/appium-webdriver","owner":"morellexf13","description":"📱 Appium Selenium Webdriver Starter Boilerplate for NodeJS with Mocha \u0026 AWS Devicefarm insights. Test your mobile apps with ease!","archived":false,"fork":false,"pushed_at":"2023-05-22T19:14:20.000Z","size":30266,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-05T22:08:45.923Z","etag":null,"topics":["appium","automation","aws","devicefarm","in-portfolio","mocha","nodejs","selenium","selenium-webdriver","starter-boilerplate"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morellexf13.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-24T21:33:58.000Z","updated_at":"2023-04-12T17:35:55.000Z","dependencies_parsed_at":"2024-11-15T04:16:43.114Z","dependency_job_id":null,"html_url":"https://github.com/morellexf13/appium-webdriver","commit_stats":null,"previous_names":["morellexf26/appium-webdriver"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/morellexf13/appium-webdriver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morellexf13%2Fappium-webdriver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morellexf13%2Fappium-webdriver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morellexf13%2Fappium-webdriver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morellexf13%2Fappium-webdriver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morellexf13","download_url":"https://codeload.github.com/morellexf13/appium-webdriver/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morellexf13%2Fappium-webdriver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31668047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T17:19:37.612Z","status":"online","status_checked_at":"2026-04-11T02:00:05.776Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appium","automation","aws","devicefarm","in-portfolio","mocha","nodejs","selenium","selenium-webdriver","starter-boilerplate"],"created_at":"2025-01-23T13:18:25.478Z","updated_at":"2026-04-11T03:33:16.488Z","avatar_url":"https://github.com/morellexf13.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\n    \u003cbr/\u003e\n    📱\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    Appium Webdriver\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n  \u003c/h1\u003e\n  \u003csup\u003e\n    \u003cbr /\u003e\n Appium Selenium Webdriver Starter Boilerplate for NodeJS with Mocha \u0026 AWS Devicefarm insights. Test your mobile apps with ease!\u003c/em\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n\n[![Build status](https://img.shields.io/github/actions/workflow/status/morellexf13/appium-webdriver/build.yml?branch=main\u0026label=%20\u0026logo=github\u0026logoColor=white\u0026style=for-the-badge)](https://github.com/morellexf13/appium-webdriver/actions/workflows/build.yml)\n[![Version](https://img.shields.io/github/v/tag/morellexf13/appium-webdriver?label=%20\u0026style=for-the-badge)](https://github.com/morellexf13/appium-webdriver/releases)\n[![License](https://img.shields.io/badge/-MIT-f56565.svg?longCache=true\u0026style=for-the-badge)](https://github.com/morellexf13/appium-webdriver/blob/main/LICENSE)\n[![Package Monthly Downloads](https://img.shields.io/npm/dm/appium-webdriver?label=%20\u0026style=for-the-badge)](https://www.npmjs.com/package/appium-webdriver)\n[![Docs](https://img.shields.io/badge/-Docs-blue.svg?style=for-the-badge)](https://www.selenium.dev/documentation/overview/)\n\n  \u003c/sup\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n❗️ This guide is mainly intended to be used as an Android User.\n\n## ✨ Pre-requisites\n\n- Install Node (https://nodejs.org/en/download/)\n- Install Java (https://www.java.com/en/)\n- Setup `ANDROID_HOME` \u0026 `JAVA_HOME`\n- Install Android Studio (If you want to test using an emulator)\n\n  \\*In order to get your app selectors I recommend you to:\n\n- Install Appium Desktop version, it can be found [here](https://github.com/appium/appium-desktop/releases/).\n\n  Make sure that both host \u0026 port are configured as you can see in the image bellow.\n  \u003cimg alt='Appium Desktop' src=\"./screenshots/appium-gui.png\" /\u003e\n\n  Why not the terminal version? because this one is easier to configure and you will have a better way to see what is happening while the app is running 😊\n\n- Install Appium Inspector, it can be found [here](https://github.com/appium/appium-inspector/releases).\n\n  1. Open the application you've just installed.\n  2. Type `0.0.0.0` in Remote Host.\n  3. Type `4723` in Remote Port.\n  4. Type '/wd/hub' in Remote Path.\n  5. Configure your \"Desired Capabilities\":\n     There are tons of options but you only need this to start.\n\n     ```json\n     {\n       \"platformName\": \"Android\",\n       \"appium:platformVersion\": \"12\",\n       \"appium:deviceName\": \"Android Emulator\",\n       \"appium:app\": \"{PATH TO APK OR IPA FILE}\",\n       \"appium:automationName\": \"UiAutomator2\" // Default option\n     }\n     ```\n\n     Read more about desired capabilities [here](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md).\n\n     \u003cimg alt='Appium Inspector' src=\"./screenshots/appium-inspector.png\" /\u003e\n\nYou'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.\nAlways try to set accessibility ids! 🫡\n\n\u003cimg alt='Appium Inspector' src=\"./screenshots/appium-inspector-2.png\" /\u003e\n\n\u003cbr\u003e\n\n## 🚀 Install \u0026 Run boilerplate\n\nInstall it locally and run in easy steps\n\n```\n1- Start Appium Desktop Server\n2- cd appium-webdriver\n3- npm install\n4- npm test\n```\n\n\u003cimg alt='NPM Test' src=\"./screenshots/npm-test.png\" /\u003e\n\n## 📊 Run tests with allure reports\n\nPre-requisites:\n\n```\nbrew install allure\n```\n\nGenerate \u0026 Open\n\n```\nnpm run test-output-allure\n```\n\n\u003cimg alt='Allure Report' src=\"./screenshots/allure-report.png\" /\u003e\n\n## 👨🏼‍🎨 Run tests and output JSON\n\n```\nnpm run test-output-json\n```\n\n```json\n{\n  \"stats\": {\n    \"suites\": 1,\n    \"tests\": 1,\n    \"passes\": 1,\n    \"pending\": 0,\n    \"failures\": 0,\n    \"start\": \"2022-06-24T12:46:05.856Z\",\n    \"end\": \"2022-06-24T12:46:16.671Z\",\n    \"duration\": 10815\n  },\n  \"tests\": [\n    {\n      \"title\": \"should add product to cart\",\n      \"fullTitle\": \"Verify Add to cart scenarios on Apptim app should add product to cart\",\n      \"file\": \"/Users/morellexf13/Documents/GitHub/appium-webdriver/nodejswd/test/specs/index.js\",\n      \"duration\": 3766,\n      \"currentRetry\": 0,\n      \"err\": {}\n    }\n  ],\n  \"pending\": [],\n  \"failures\": [],\n  \"passes\": [\n    {\n      \"title\": \"should add product to cart\",\n      \"fullTitle\": \"Verify Add to cart scenarios on Apptim app should add product to cart\",\n      \"file\": \"/Users/morellexf13/Documents/GitHub/appium-webdriver/nodejswd/test/specs/index.js\",\n      \"duration\": 3766,\n      \"currentRetry\": 0,\n      \"err\": {}\n    }\n  ]\n}\n```\n\n\u003cbr\u003e\n\n\u003cdiv id=\"create-zipped-test-package\"\u003e\n\n## 🗳 Create a Zipped Test Package File\n\n```\nnpm run package\n```\n\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## 📱 How to setup for Devicefarm\n\n\u003cbr\u003e\n\n1- Adapt the test/specs, page objects and apk to your needs.\n\n2- Remember to remove the `capabilities` parameter in `test/base.js`. Custom capabilities will only work for local tests.\n\n```js\ndriverSetup() {\n    return driver.init(capabilities);\n  }\n```\n\n3- Create a \u003ca href=\"#create-zipped-test-package\"\u003ezipped test package\u003c/a\u003e. You will need this later 👀.\n\n4- Go to AWS Devicefarm and create a project, use the name you want and go to the next step.\n\u003cimg alt='Devicefarm Step 1' src=\"./screenshots/devicefarm/1.png\" /\u003e\n\n5- Choose the APK file you want to upload and go to the next step.\n\u003cimg alt='Devicefarm Step 2' src=\"./screenshots/devicefarm/2.png\" /\u003e\n\n6- Select the Appium Node.js option.\n\u003cimg alt='Devicefarm Step 3' src=\"./screenshots/devicefarm/3.png\" /\u003e\n\n7- Upload your \u003ca href=\"#create-zipped-test-package\"\u003ezipped test package\u003c/a\u003e and go to the next step.\n\n\u003cimg alt='Devicefarm Step 4' src=\"./screenshots/devicefarm/4.png\" /\u003e\n\n❗️This is important, you need to setup the test spec yml file following the example bellow.\n\n```yml\nversion: 0.1\n\nphases:\n  install:\n    commands:\n      - export NVM_DIR=$HOME/.nvm\n      - . $NVM_DIR/nvm.sh\n      - nvm install 16.15.1\n\n      - cd $DEVICEFARM_TEST_PACKAGE_PATH\n      - npm install *.tgz\n\n      - export APPIUM_VERSION=1.22.2\n      - avm $APPIUM_VERSION\n      - ln -s /usr/local/avm/versions/$APPIUM_VERSION/node_modules/.bin/appium  /usr/local/avm/versions/$APPIUM_VERSION/node_modules/appium/bin/appium.js\n\n  pre_test:\n    commands:\n      - echo \"Start appium server\"\n      - \u003e-\n        appium --log-timestamp --base-path /wd/hub\n        --default-capabilities \"{\\\"deviceName\\\": \\\"$DEVICEFARM_DEVICE_NAME\\\", \\\"platformName\\\":\\\"$DEVICEFARM_DEVICE_PLATFORM_NAME\\\",\n        \\\"app\\\":\\\"$DEVICEFARM_APP_PATH\\\", \\\"udid\\\":\\\"$DEVICEFARM_DEVICE_UDID\\\", \\\"platformVersion\\\":\\\"$DEVICEFARM_DEVICE_OS_VERSION\\\",\n        \\\"chromedriverExecutable\\\":\\\"$DEVICEFARM_CHROMEDRIVER_EXECUTABLE\\\"}\"\n        \u003e\u003e $DEVICEFARM_LOG_DIR/appiumlog.txt 2\u003e\u00261 \u0026\n\n      - \u003e-\n        start_appium_timeout=0;\n        while [ true ];\n        do\n            if [ $start_appium_timeout -gt 60 ];\n            then\n                echo \"appium server never started in 60 seconds. Exiting\";\n                exit 1;\n            fi;\n            grep -i \"Appium REST http interface listener started on 0.0.0.0:4723\" $DEVICEFARM_LOG_DIR/appiumlog.txt \u003e\u003e /dev/null 2\u003e\u00261;\n            if [ $? -eq 0 ];\n            then\n                echo \"Appium REST http interface listener started on 0.0.0.0:4723\";\n                break;\n            else\n                echo \"Waiting for appium server to start. Sleeping for 1 second\";\n                sleep 1;\n                start_appium_timeout=$((start_appium_timeout+1));\n            fi;\n        done;\n\n  test:\n    commands:\n      - cd $DEVICEFARM_TEST_PACKAGE_PATH/\n      - npm install\n      - npm test\n\n  post_test:\n    commands:\n\nartifacts:\n  - $DEVICEFARM_LOG_DIR\n```\n\n\u003cimg alt='Devicefarm Step 5' src=\"./screenshots/devicefarm/5.png\" /\u003e\n\n8- Select a default device pool or create your own and go to the next step, start the session and wait 🤞.\n\u003cimg alt='Devicefarm Step 6' src=\"./screenshots/devicefarm/6.png\" /\u003e\n\n9- Your Devicefarm test has ended successfully! 🌈\n\u003cimg alt='Devicefarm Step 7' src=\"./screenshots/devicefarm/7.png\" /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorellexf13%2Fappium-webdriver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorellexf13%2Fappium-webdriver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorellexf13%2Fappium-webdriver/lists"}