Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hmallen99 committed Feb 19, 2025
1 parent ccdb271 commit b0a96ab
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions packages/clientNative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ if (isReactNative) {
}
```

## Environment files

The React Native app uses the `.env.remote.default` config, rather than the `.env.local.default` config. The app is hardcoded to load the Mariale experience. If the values in the config are upadted, you must reset the React Native env cache by starting metro with the `--reset-cache` flag.

To run the app with a local dev server, you must change from ssl/https to unsecure http. This is because the iOS simulator does not trust self-signed https certificates. A diff with the relevant changes can be viewed here: https://github.com/rebeckerspecialties/ir-engine/pull/55/files.

## Rendering Canvas

To polyfill the DOM canvas, we use [Expo's GLView](https://docs.expo.dev/versions/latest/sdk/gl-view/). This canvas must be created through React's declarative paradigm, which causes some reorganization of render logic.
Expand All @@ -37,6 +43,10 @@ To polyfill the DOM canvas, we use [Expo's GLView](https://docs.expo.dev/version
> **Warning**: iOS is the only fully supported platform. Errors may occur when building for Android.
## Additional repo checkout

Please check out https://github.com/hmallen99/irpro-mariale to `packages/projects/projects/theinfinitereality/` before proceeding.

## Step 1: Start the Metro Server

First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
Expand Down

0 comments on commit b0a96ab

Please sign in to comment.