mirror of
https://github.com/selfxyz/self.git
synced 2026-04-05 03:00:53 -04:00
166 lines
5.4 KiB
Markdown
166 lines
5.4 KiB
Markdown
# OpenPassport App
|
|
|
|
## Requirements
|
|
|
|
| Requirement | Version | Installation Guide |
|
|
| ----------- | -------- | ------------------------------------------------------------------------ |
|
|
| nodejs | > v18 | [Install nodejs](https://nodejs.org/) |
|
|
| ruby | >= 3.1.0 | [Install ruby](https://www.ruby-lang.org/en/documentation/installation/) |
|
|
| circom | Latest | [Install circom](https://docs.circom.io/) |
|
|
| snarkjs | Latest | [Install snarkjs](https://github.com/iden3/snarkjs) |
|
|
| watchman | Latest | [Install watchman](https://facebook.github.io/watchman/) |
|
|
|
|
### Android
|
|
|
|
| Requirement | Version | Installation Guide |
|
|
| -------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Java | 17 | [Install Java](https://www.oracle.com/java/technologies/javase-jdk17-downloads.html) |
|
|
| Android Studio | Latest | [Install Android Studio](https://developer.android.com/studio) |
|
|
| Android SDK | Latest | [Install Android SDK](https://developer.android.com/studio#downloads) |
|
|
| Android Ndk | 26.1.10909125 | [Install NDK](https://developer.android.com/studio) or [GPT4 guide](https://chatgpt.com/share/a6e2544b-d32a-4554-a452-402511d03ffc) |
|
|
|
|
### iOS
|
|
|
|
| Requirement | Version | Installation Guide |
|
|
| ----------- | ------- | --------------------------------------------------- |
|
|
| Xcode | Latest | [Install Xcode](https://developer.apple.com/xcode/) |
|
|
| cocoapods | Latest | [Install cocoapods](https://cocoapods.org/) |
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
yarn install
|
|
yarn install-app
|
|
```
|
|
|
|
## Run the app
|
|
|
|
First, connect your phone to your computer and allow access.
|
|
|
|
### Android
|
|
|
|
Create the file `android/local.properties` with the following content:
|
|
|
|
```
|
|
sdk.dir=/Users/<your-user-name>/Library/Android/sdk
|
|
```
|
|
|
|
Launch the react-native server:
|
|
|
|
```
|
|
yarn start
|
|
```
|
|
|
|
Press `a` to open the app on Android.
|
|
|
|
To see the Android logs you'll have to use the Android Studio Logcat.
|
|
|
|
**EDIT**: to test the app on android, see [this issue](https://github.com/zk-passport/openpassport/issues/191) temporarily
|
|
|
|
### iOS
|
|
|
|
> :warning: To run the app on iOS, you will need a paying Apple Developer account. Free accounts can't run apps that use NFC reading.<br/>
|
|
> Contact us if you need it to contribute.
|
|
|
|
Open the ios project on Xcode and add your provisionning profile in Targets > OpenPassport > Signing and Capabilities
|
|
|
|
Then, install pods:
|
|
|
|
```
|
|
cd ios
|
|
pod install
|
|
```
|
|
|
|
And run the app in Xcode.
|
|
|
|
#### react-native-haptic-feedback v2.3.3
|
|
|
|
To create a successful build, "Target Membership" for the AudioToolbox.framework needs to be updated.
|
|
|
|
Pods Project > Frameworks > iOS > AudioToolbox.framework
|
|
|
|
Then click on the "+" button in the "Target Membership" box and add `RNReactNativeHapticFeedback`
|
|
|
|
[more info](https://github.com/mkuczera/react-native-haptic-feedback/issues/142)
|
|
|
|
## Modify the circuits
|
|
|
|
If you want to modify the circuits, you'll have to adapt a few things.
|
|
|
|
First, go to the `circuit` folder of the monorepo, modify the circuits and build them.
|
|
|
|
Then, upload the zipped zkeys and dat files at publicly available urls and replace the urls in `app/src/utils/zkeyDownload.ts`.
|
|
|
|
Adapt the input generation in `common/src/utils/generateInputs.ts`, and adapt and redeploy the contracts.
|
|
|
|
### Android
|
|
|
|
Find your android ndk path. It should be something like `/Users/<your-user-name>/Library/Android/sdk/ndk/23.1.7779620`
|
|
Build the android native module:
|
|
|
|
```
|
|
export ANDROID_NDK="<your-android-ndk-path>"
|
|
./scripts/build_android_module.sh
|
|
```
|
|
|
|
### iOS
|
|
|
|
Find your [development team id](https://chat.openai.com/share/9d52c37f-d9da-4a62-acb9-9e4ee8179f95) and run:
|
|
|
|
```
|
|
export DEVELOPMENT_TEAM="<your-development-team-id>"
|
|
./scripts/build_ios_module.sh
|
|
```
|
|
|
|
## Export a new release
|
|
|
|
### Android
|
|
|
|
#### Export as apk
|
|
|
|
```
|
|
cd android
|
|
./gradlew assembleRelease
|
|
```
|
|
|
|
The built apk it located at `android/app/build/outputs/apk/release/app-release.apk`
|
|
|
|
#### Publish on the Play Store
|
|
|
|
As explained [here](https://reactnative.dev/docs/signed-apk-android), first setup `android/app/my-upload-key.keystore` and the private vars in `~/.gradle/gradle.properties`, then run:
|
|
|
|
```
|
|
npx react-native build-android --mode=release
|
|
```
|
|
|
|
This builds `android/app/build/outputs/bundle/release/app-release.aab`.
|
|
|
|
Then to test the release on an android phone, delete the previous version of the app and run:
|
|
|
|
```
|
|
yarn android --mode release
|
|
```
|
|
|
|
Don't forget to bump `versionCode` in `android/app/build.gradle`.
|
|
|
|
### iOS
|
|
|
|
In Xcode, go to `Product>Archive` then follow the flow.
|
|
|
|
Don't forget to bump the build number.
|
|
|
|
## FAQ
|
|
|
|
If you get something like this:
|
|
|
|
```
|
|
'std::__1::system_error: open: /openpassport/app: Operation not permitted'
|
|
```
|
|
|
|
You might want to try [this](https://stackoverflow.com/questions/49443341/watchman-crawl-failed-retrying-once-with-node-crawler):
|
|
|
|
```
|
|
watchman watch-del-all
|
|
watchman shutdown-server
|
|
```
|