Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task] DEP-412: RN 2.0.0 #34

Merged
merged 2 commits into from
Aug 4, 2023
Merged

[Task] DEP-412: RN 2.0.0 #34

merged 2 commits into from
Aug 4, 2023

Conversation

asklausen
Copy link
Collaborator

@asklausen asklausen commented Aug 3, 2023

Purpose

  • Update RN to 2.0.0
  • Support Android 3.1.1
  • Support iOS 4.0.1
  • Allow integrators to choose which frameworks to include when using our RN wrapper (Android, iOS)
  • General cleanup and improvements
  • Updated READMEs

External References (e.g. Jira / Zeplin / Confluence)

DEP-412

@asklausen asklausen changed the title [Task] DEP-398: RN 2.0.0 [Task] DEP-412: RN 2.0.0 Aug 3, 2023
@Zzhelyaz
Copy link

Zzhelyaz commented Aug 3, 2023

All major flows verified.


# Android/IJ
#
.idea
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could add a few more items for Android, such as bin/, gen/, etc. Let's take this offline and I can send you what we have set up internally for the native SDK.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not needed

@@ -1,21 +0,0 @@
MIT License
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this removed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind, saw the updates to the README in the next commit 👍

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because the licence is specified via url in the readme

README.md Outdated
[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/getyoti/yoti-doc-scan-react-native?label=latest%20release)](https://github.com/getyoti/yoti-doc-scan-react-native/releases) [![Publish Release](https://github.com/getyoti/yoti-doc-scan-react-native/workflows/Publish%20Release/badge.svg)](https://github.com/getyoti/yoti-doc-scan-react-native/actions?query=workflow%3A%22Publish+Release%22)

Yoti is an identity checking platform that allows organisations to verify who people are, online and in person. The Yoti Doc Scan SDK allows the user to take a photo of their identifying document which we verify instantly and prepare a response which your system can then retrieve. Further information can be found in the [documentation](https://developers.yoti.com/yoti/getting-started-docscan).
A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti-doc-scan-android) and [iOS](https://github.com/getyoti/yoti-doc-scan-ios). Yoti IDV allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site.s
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo at the end

@@ -101,162 +57,105 @@ If you're using **Proguard** or other obfuscation tool, add the following config
-dontwarn javax.annotation.Nullable
```


Depending on your Android project setup and version of React Native, you
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were these troubleshooting steps removed?

Copy link
Collaborator Author

@asklausen asklausen Aug 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because those steps are about general errors that can occur, and have nothing to do with our sdk specifically

"start": "react-native start"
},
"dependencies": {
"react": "^17.0.2",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a big fan of version ranges, since they might introduce changes we might not want/anticipate. 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the range includes minors + patches. not majors, so it's fine

- Open the `ios/example.xcworkspace` file with XCode
- Run a build as you regularly would, preferrably on a device with the Yoti app installed
### Android
To continue your installation with Android, you should run `yarn start` and `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081` (or `adb reverse tcp:8081 tcp:8081` if using a simulator) from the `example` directory. , and then open the `example/android` project in Android Studio. You can now sync Gradle and build the app.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit nitpicking here, but on Android it's "emulator" 😄

- If you are running on a physical device, remember to execute `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081`. You can find the appropriate device id by running `adb devices`

# Android (using React Native CLI)
- Simply execute `yarn run android` in the `example` folder
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is useful, it's way easier to simply run the app like this, I would not remove it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wasn't removed. just moved.

versionCode 110
versionName "1.1.0"
versionCode 1
versionName "1.0.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that given this is an example app, it probably does not matter, but when downgrading versionCode and attempting to run (basically update) an app, you'd get an error saying you are attempting to install an older version and asking you to uninstall the previous newer one first.

Again, might not matter since this would never get published, but still thought I'd mention this.

@@ -192,7 +76,12 @@ android {

dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
implementation "com.facebook.react:react-native:0.68.5" // From node_modules
implementation "com.facebook.react:react-native:0.68.5"
implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:${rootProject.ext.yotiSdkVersion}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before we included all module deps, I'm wondering if we should change that now...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using id docs + liveness as default

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But liveness is commented below

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its not

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, sorry, scrolled past it

@asklausen asklausen merged commit 5b3ddda into master Aug 4, 2023
@asklausen asklausen deleted the release/DEP-398-2.0.0 branch August 4, 2023 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants