Skip to content

Commit f43395a

Browse files
committed
Update readme
1 parent e45bb3a commit f43395a

File tree

1 file changed

+55
-6
lines changed

1 file changed

+55
-6
lines changed

README.md

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,60 @@
11
# webdriverio-appium-app-browserstack
2-
[WebdriverIO](http://webdriver.io/) Integration with BrowserStack.
2+
This repository demonstrates how to run Appium tests using [WebdriverIO](http://webdriver.io/) on BrowserStack App Automate.
33

4-
![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
5-
6-
<img src = "http://webdriver.io/images/webdriverio.png" height = "100">
4+
<div align="center">
5+
<img src = "https://www.browserstack.com/images/layout/browserstack-logo-600x315.png" > <br>
6+
<img src = "https://webdriver.io/img/webdriverio.png" height="140px">
7+
</div>
78

89
Code samples to get started with Appium tests for your Native App using WebdriverIO.
910

10-
## Resources
11-
* [Get Started guide](https://www.browserstack.com/app-automate/appium-webdriverio)
11+
## Setup
12+
-----------
13+
### Requirements
14+
* Node.js
15+
- Install at least **v8.11.2 or higher** as this is the oldest active LTS version
16+
- If you don't have Node installed, you can get get it installed from [here](https://nodejs.org/en/)
17+
18+
### Install Dependencies
19+
To install the dependencies for Android tests, run :
20+
```sh
21+
cd android
22+
npm i
23+
```
24+
Or,
25+
To install the dependencies for iOS tests, run :
26+
```sh
27+
cd ios
28+
npm i
29+
```
30+
31+
## Getting Started
32+
-----------
33+
Getting Started with Appium tests using WebdriverIO on BrowserStack couldn't be easier!
34+
35+
### Run first test:
36+
- Switch to `run_first_test` directory under [Android examples](./android) or [iOS examples](./ios)
37+
- Follow the steps outlined in the documentation - [Get Started with your first test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/nodejs/webdriverio)
38+
39+
### Speed up test execution with parallel testing :
40+
41+
- Switch to `run_parallel_test` directory under [Android examples](./android) or [iOS examples](./ios)
42+
- Follow the steps outlined in the documentation - [Get Started with parallel testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/nodejs/webdriverio/parallelize-tests)
43+
44+
### Use Local testing for apps that access resources hosted in development or testing environments :
45+
46+
- Switch to `run_local_test` directory under [Android examples](./android) or [iOS examples](./ios)
47+
- Follow the steps outlined in the documentation - [Get Started with Local testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/nodejs/webdriverio/local-testing)
48+
49+
**Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)
50+
51+
52+
## Integration with other Java frameworks
53+
-----------
54+
For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)
55+
56+
57+
## Getting Help
58+
-----------
59+
If 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).
60+

0 commit comments

Comments
 (0)