Skip to content

Commit c48a83b

Browse files
authored
Update README.md
1 parent 0548738 commit c48a83b

File tree

1 file changed

+39
-27
lines changed

1 file changed

+39
-27
lines changed

README.md

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,62 @@
11
# ComplyCube Example App
2-
2+
33
This repository provides a pre-built UI that uses the ComplyCube SDK. It guides you through the ComplyCube identity verification process, which includes collecting client ID documents, proof of address documents, and biometric selfies.
4-
4+
55
> :information_source: Please get in touch with your **Account Manager** or **[support](https://support.complycube.com/hc/en-gb/requests/new)** to get access to our Mobile SDK.
6-
6+
77
## To run the app
8-
9-
### Install the flutter pub
10-
11-
1. To add the repo token execute this command
12-
8+
9+
### Installing Flutter dependencies
10+
11+
#### Add Repository Token for Dart
12+
13+
1. To access the ComplyCube repository, you must add a repository token. Run the following command in your terminal:
14+
1315
```bash
1416
dart pub token add "https://complycuberepo.jfrog.io/artifactory/api/pub/cc-pub-release-local"
1517
```
1618

17-
3. And the add the token provided by jFrog repository.
19+
After executing the command, you will need to add the token provided by the jFrog repository.
20+
21+
#### Install Dart packages
1822

19-
4. Install the pub
23+
1. To install the required Dart packages, run the following command:
2024

2125
```bash
2226
dart pub get
2327
```
24-
28+
2529
### Install CocoaPods
26-
27-
1. Before using the ComplyCube SDK, install the Cocoapods Artifactory plugin by running the following command in your terminal:
28-
30+
31+
1. Before using the ComplyCube SDK, install the CocoaPods Artifactory plugin by running the following command in your terminal:
32+
2933
```bash
3034
gem install cocoapods-art
3135
```
32-
36+
3337
2. To add the library, copy your repository credentials into a `.netrc` file to your home directory and setup the repository:
34-
38+
3539
```bash
3640
pod repo-art add cc-cocoapods-release-local "https://complycuberepo.jfrog.io/artifactory/api/pods/cc-cocoapods-release-local"
3741
```
38-
42+
3943
### Add Artifactory Credentials for Gradle
40-
41-
1. Replace `ARTIFACTORY_USER` and `ARTIFACTORY_PASSWORD` in `android/gradle.properties` with your JFrog User and encrypted JFrog Password
42-
43-
44-
### Update Token and Client ID in Source Code
45-
1. [Create a client](), and replace `CLIENT_ID` in `App.js` with the returned Client ID.
46-
2. [Generate an SDK token](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide#id-3.-generate-an-sdk-token), and replace `SDK_TOKEN` in `App.js` with the generated token.
47-
44+
45+
1. In the `android/gradle.properties` file, replace `ARTIFACTORY_USER` and `ARTIFACTORY_PASSWORD` with your JFrog Username and the encrypted JFrog Password.
46+
4847
### Run the apps
49-
1. Run the android app by running `flutter run`
50-
2. Run the ios app only by running `flutter run -d ios`
48+
49+
1. [Create a Client ID](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide#id-2.-create-a-client).
50+
2. [Generate an SDK token](https://docs.complycube.com/documentation/guides/mobile-sdk-guide/mobile-sdk-integration-guide#id-3.-generate-an-sdk-token).
51+
3. In the `main.dart` file, replace `CLIENT_ID` and `SDK_TOKEN` with the generated values from the previous steps.
52+
4. Run the Android app:
53+
54+
```bash
55+
flutter run
56+
```
57+
58+
5. Run the iOS app:
59+
60+
```bash
61+
flutter run -d ios
62+
```

0 commit comments

Comments
 (0)