Skip to content

Commit 936a677

Browse files
ISS-183379: Update hybrid mobile SDK docs with sample app section(React Native, Expo, Cordova) (#264)
* Update the quick start guide for Cordova * Add sample section for Cordova * Add sample section in Expo mobile SDK documentation * Add sample section in React Native mobile SDK documentation * Improve formatting * Fix typo * Improve readability * Use tab mechanism * Improve formatting * Improve formatting and readability
1 parent dac152c commit 936a677

File tree

3 files changed

+92
-2
lines changed

3 files changed

+92
-2
lines changed

fern/docs/pages/sdks/mobile/cordova/quickstart.mdx

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This guide helps you integrate the DevRev SDK into your Cordova app.
55
## Requirements
66

77
- Cordova CLI 10.0.0 or higher.
8-
- A minimum deployment target of Android 5.0 (API level 21) or iOS 11.
8+
- Minimum deployment target Android SDK 24 or iOS 15.
99

1010
## Installation
1111

1212
To install the DevRev SDK, run the following command:
1313

1414
```sh
15-
cordova plugin add devrev-cordova-plugin
15+
cordova plugin add devrev/sdk-cordova
1616
```
1717

1818
## Set up the DevRev SDK
@@ -30,3 +30,38 @@ The SDK will be ready for use once you execute the following configuration metho
3030
```javascript
3131
DevRev.configure(appID, successCallback, errorCallback)
3232
```
33+
34+
## Sample app
35+
A sample app with use cases for the DevRev Cordova plugin is provided as part of our [public repository](https://github.com/devrev/devrev-sdk-cordova). To set up and run the sample app:
36+
37+
```sh
38+
cd sample
39+
npm install
40+
cordova platform add android
41+
cordova platform add ios
42+
```
43+
44+
<Tabs>
45+
<Tab title="Android">
46+
```sh
47+
cordova run android
48+
```
49+
OR open `platforms/android` in Android Studio and run the app.
50+
</Tab>
51+
<Tab title="iOS">
52+
1. Open `platforms/ios/Podfile` and ensure it contains:
53+
```ruby
54+
platform :ios, '15.0'
55+
```
56+
2. Install dependencies:
57+
```sh
58+
cd platforms/ios
59+
pod install
60+
```
61+
3. Run the app:
62+
```sh
63+
cordova run ios
64+
```
65+
OR open `DevRevSDKSample.xcworkspace` in Xcode and run the app.
66+
</Tab>
67+
</Tabs>

fern/docs/pages/sdks/mobile/react-native/quickstart-expo.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,33 @@ The SDK will be ready for use once you execute the following configuration metho
4141
```typescript
4242
DevRev.configure(appID: string)
4343
```
44+
45+
## Sample app
46+
A sample app with use cases for the DevRev Expo plugin has been provided as a part of our [public repository](https://github.com/devrev/devrev-sdk-expo). To set up and run the sample app:
47+
48+
1. Go to sample directory:
49+
```sh
50+
cd sample
51+
```
52+
53+
2. Install dependencies:
54+
```sh
55+
yarn install
56+
```
57+
58+
3. Run clean and prebuild:
59+
```sh
60+
npx expo prebuild --clean
61+
```
62+
63+
4. Run the app On Android:
64+
```sh
65+
npx expo run:android
66+
```
67+
OR open `android` in Android Studio and run the app.
68+
69+
5. Run the app On iOS:
70+
```sh
71+
npx expo run:ios
72+
```
73+
OR open `ios/DevRevSDKSample.xcworkspace` in Xcode and run the app.

fern/docs/pages/sdks/mobile/react-native/quickstart.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,28 @@ The SDK will be ready for use once you execute the following configuration metho
2121
```typescript
2222
DevRev.configure(appID: string)
2323
```
24+
25+
## Sample app
26+
A sample app with use cases for the DevRev React Native plugin has been provided as a part of our [public repository](https://github.com/devrev/devrev-sdk-react-native). To set up and run the sample app:
27+
28+
1. Go to the sample directory:
29+
```sh
30+
cd sample
31+
```
32+
33+
2. Install dependencies:
34+
```sh
35+
yarn install
36+
```
37+
38+
3. For iOS, run:
39+
```sh
40+
cd ios
41+
pod install
42+
```
43+
44+
4. Run the app on Android or iOS using:
45+
```sh
46+
npx react-native start
47+
```
48+
Or open `android` directory in Android Studio or `ios/DevRevSDKSample.xcworkspace` in Xcode and run the app from there.

0 commit comments

Comments
 (0)