App AutomateGet startedRun a sample build

Appium with JestJS

Your guide to running tests using JestJS on BrowserStack’s Appium Grid of 3000+ real devices.

Run tests on 3000+ real devices and desktop browsers

Prerequisites

You need to have BrowserStack Username and Access key, which you can find in your account profile. If you have not created an account yet, you can sign up for a Free Trial
Node v16 installed on your machine.

Run a sample build

Run a sample JestJS test build using the following steps:

Get our sample project

Get our sample project using one of the following options.

Option 1: Download the project

Download ZIP

Option 2: Clone the sample repository

Clone our sample repository and navigate to the root folder.

Copy

    git clone -b sdk https://github.com/browserstack/jest-appium-app-browserstack
cd jest-appium-app-browserstack

Configure the config file

Configure a few parameters in the browserstack.yml config file to run the sample build.

Set access credentials

Use the userName and accessKey variables to set your BrowserStack access credentials in the browserstack.yml file to authenticate your tests.

Configure browser or device combinations

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

Copy and replace the `browserstack.yml` config file

Replace the contents of browserstack.yml situated in the root directory of this project with the given config.

```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
app: YOUR_APP_ID
platforms:
  - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
    YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
    YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
  - YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
    YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
    YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
  - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
    YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
    YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample 
```

browserstack.yml

      
      
            Github icon
            
          View on Github
      
      
      
    

        
            Copy icon
            
          
        Copy
      
    userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
app: bs://sample.app
platforms:
  - platformName: android
    deviceName: Samsung Galaxy S22 Ultra
    platformVersion: 12.0
  - platformName: android
    deviceName: Google Pixel 7 Pro
    platformVersion: 13.0
  - platformName: android
    deviceName: OnePlus 9
    platformVersion: 11.0
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample

  

Execute the build on BrowserStack

Based on the devices and app selected, cd to the right project, install dependencies, and run a sample test build on BrowserStack

      
            Android
          
            iOS
          
```bash
cd android
npm install
npm run sample-test
```

            Copy icon
            
        Copy
      
    cd android
npm install
npm run sample-test

```bash
cd ios
npm install
npm run sample-test
```

            Copy icon
            
        Copy
      
    cd ios
npm install
npm run sample-test