-
Notifications
You must be signed in to change notification settings - Fork 6
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
Conversation
All major flows verified. |
|
||
# Android/IJ | ||
# | ||
.idea |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why was this removed?
There was a problem hiding this comment.
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 👍
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
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. 🤔
There was a problem hiding this comment.
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
example/README.md
Outdated
- 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. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
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}" |
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its not
There was a problem hiding this comment.
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
a04d396
to
8d532e8
Compare
Purpose
External References (e.g. Jira / Zeplin / Confluence)
DEP-412