{"id":21944733,"url":"https://github.com/browserstack/mocha-appium-app-browserstack","last_synced_at":"2026-02-02T21:11:33.445Z","repository":{"id":186026268,"uuid":"672746679","full_name":"browserstack/mocha-appium-app-browserstack","owner":"browserstack","description":" Mocha nodeJS Appium integration with BrowserStack","archived":false,"fork":false,"pushed_at":"2024-11-20T08:47:18.000Z","size":35432,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-22T21:05:59.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-31T04:31:30.000Z","updated_at":"2024-06-19T03:35:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"60aed572-d12b-4924-8fbc-7fd6538f368d","html_url":"https://github.com/browserstack/mocha-appium-app-browserstack","commit_stats":null,"previous_names":["browserstack/mocha-appium-app-browserstack"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fmocha-appium-app-browserstack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fmocha-appium-app-browserstack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fmocha-appium-app-browserstack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fmocha-appium-app-browserstack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/mocha-appium-app-browserstack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250324692,"owners_count":21411946,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-29T04:16:59.235Z","updated_at":"2026-02-02T21:11:28.400Z","avatar_url":"https://github.com/browserstack.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mocha-appium-app-browserstack\n\nThis repository demonstrates how to run Appium NodeJS mocha tests on BrowserStack App Automate.\n\n## Setup\n\n### Requirements\n\n1. Node.js\n\n    - If not installed, install Node.js from [here](https://nodejs.org/en/download/)\n\n    - Ensure you have node \u0026 npm installed by running `node -v` \u0026 `npm -v`\n\n### Install the dependencies\n\nFor Android tests, run the following command in project's base directory :\n\n```\ncd android\nnpm install\n```\nOr,\n\nFor dependencies for iOS tests, run following command in project's base directory :\n```\ncd ios\nnpm i\n```\n## Getting Started\n\nGetting Started with Appium tests in NodeJS mocha   on BrowserStack couldn't be easier!\n\n### Run your first test :\n\n**1. Upoad your Android or iOS App**\n\nUpload your Android app (.apk or .aab file) or iOS app (.ipa file) to BrowserStack servers using our REST API. Here is an example cURL request :\n\n```\ncurl -u \"YOUR_USERNAME:YOUR_ACCESS_KEY\" \\\n-X POST \"https://api-cloud.browserstack.com/app-automate/upload\" \\\n-F \"file=@/path/to/apk/file\"\n```\n\nEnsure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on.\n\n**Note**: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our [sample Android app](https://www.browserstack.com/app-automate/sample-apps/android/WikipediaSample.apk) or [sample iOS app](https://www.browserstack.com/app-automate/sample-apps/ios/BStackSampleApp.ipa).\n\n**2. Configure and run your first test**\n\nOpen `single.conf.js` file in `Android` or in `ios` folder\n\n- Replace `YOUR_USERNAME` \u0026 `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings)\n\n- Replace `bs://\u003capp-id\u003e` wkth the URL obtained from app upload step\n\n- Set the device and OS version\n\n- If you have uploaded your own app update the test case\n\n- Run `npm run single` from android or ios folder\n\n- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)\n\n---\n\n### **Use Local testing for apps that access resources hosted in development or testing environments :**\n\n**1. Upload your Android or iOS App**\n\nUpload your Android app (.apk or .aab file) or iOS app (.ipa file) that access resources hosted on your internal or test environments to BrowserStack servers using our REST API. Here is an example cURL request :\n\n```\ncurl -u \"YOUR_USERNAME:YOUR_ACCESS_KEY\" \\\n-X POST \"https://api-cloud.browserstack.com/app-automate/upload\" \\\n-F \"file=@/path/to/apk/file\"\n```\n\nEnsure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on.\n\n**Note**: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our [sample Android Local app](https://www.browserstack.com/app-automate/sample-apps/android/LocalSample.apk) or [sample iOS Local app](https://www.browserstack.com/app-automate/sample-apps/ios/LocalSample.ipa).\n\n**2. Configure and run your local tes**\n\nOpen `local.conf.js` file in `Android` or in `ios` folder\n\n- Replace `YOUR_USERNAME` \u0026 `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings)\n\n- Replace `bs://\u003capp-id\u003e` wkth the URL obtained from app upload step\n\n- Set the device and OS version\n\n- Ensure that `local` capability is set to `true`. Within the test script, there is code snippet that automatically establishes Local Testing connection to BrowserStack servers using Javascript binding for BrowserStack Local.\n\n- If you have uploaded your own app update the test case\n\n- Run `npm run local` from android or ios folder\n\n- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)\n\n**3. Speed up test execution with parallel testing :**\n\nOpen `parallel.conf.js` file in `Android` or in `ios` folder\n\n- Replace `YOUR_USERNAME` \u0026 `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings)\n- Add multiple configurations under multiCapabilities\n\n- Replace `bs://\u003capp-id\u003e` with the URL obtained from app upload step to all configurations\n\n- Set the device and OS version to all the configuration\n\n- If you have uploaded your own app update the test case\n\n- Run `npm run parallel` from android or ios folder\n\n- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)\n\n## Integration with other NodeJS frameworks\n\nFor other NodeJS frameworks samples, refer to following repositories :\n\n- [WebdriverIO](https://github.com/browserstack/webdriverio-appium-app-browserstack)\n\nNote: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)\n\n## Getting Help\n\nIf you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fmocha-appium-app-browserstack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fmocha-appium-app-browserstack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fmocha-appium-app-browserstack/lists"}