Skip to content

Commit

Permalink
fix: update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shirakaba committed Oct 30, 2024
1 parent 1dd0b44 commit 85b1e5d
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions examples/demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@
After cloning the repository, run the following:

```sh
cd react-native-app-auth/Example
# Install the npm dependencies for the monorepo
cd react-native-app-auth
yarn

cd /examples/demo
# Install the pods for the iOS example app
cd ios && pod install
cd ios && pod install && cd ..
# Install the pods for the macOS example app
cd macos && pod install
cd macos && pod install && cd ..

# From here on, you'll need two terminals.

Expand All @@ -30,18 +33,16 @@ yarn android

# or:
# Run the macOS app (after setting `applePlatform = "macos"` in metro.config.js)
#
# Note that we do not currently support running the macOS demo simultaneously
# with iOS or Android apps, as we use the `applePlatform = "macos"` flag to
# force Metro to resolve react-native-macos instead of react-native.
yarn macos
```

### Notes
* You have to have the emulator open before running the last command. If you have difficulty getting the emulator to connect, open the project from Android Studio and run it through there.
* ANDROID: When integrating with a project that utilizes deep linking (e.g. [React Navigation deep linking](https://reactnavigation.org/docs/deep-linking/#set-up-with-bare-react-native-projects)), update the redirectUrl in your config and the `appAuthRedirectScheme` value in build.gradle to use a custom scheme so that it differs from the scheme used in your deep linking intent-filter [as seen here](https://github.com/FormidableLabs/react-native-app-auth/issues/494#issuecomment-797394994).

- If you have difficulty getting the emulator to connect, open the project from Android Studio (for Android) or Xcode (for iOS/macOS) and run it through there.
- ANDROID: When integrating with a project that utilizes deep linking (e.g. [React Navigation deep linking](https://reactnavigation.org/docs/deep-linking/#set-up-with-bare-react-native-projects)), update the redirectUrl in your config and the `appAuthRedirectScheme` value in build.gradle to use a custom scheme so that it differs from the scheme used in your deep linking intent-filter [as seen here](https://github.com/FormidableLabs/react-native-app-auth/issues/494#issuecomment-797394994).

Example:

```
// build.gradle
android {
Expand Down

0 comments on commit 85b1e5d

Please sign in to comment.