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

chore: update readme with latest instructions #13

Merged
merged 1 commit into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/open-xcode-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/xcode-components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/ios-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# iOS Troubleshooting

## Failed to build iOS project. "xcodebuild" exited with error code 70.

This error indicates that the required iOS simulator is not installed in Xcode.

```
iOS * is not installed. To use with Xcode, first download and install the platform
```

### Solution

To resolve this, install the iOS simulator through Xcode settings:

1. Open Xcode.
2. In the top menu, click on Xcode and select Settings….

![Xcode Settings](./images/open-xcode-settings.png)

3. In the Settings window, navigate to the Components tab.
4. Look for “iOS Simulator” in the list and click the Install button next to the desired version.

![Xcode Components Tab](./images/xcode-components.png)

Once the simulator is installed, retry building your iOS project.
20 changes: 11 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,39 @@ You will also need to enable the SMS and/or Email Login options to have a login

Follow these steps to get the app up and running:

1. **Clone the repository:**
1. **Set Up Your Environment**

Prepare your development environment for React Native by following the official setup guide: [React Native Environment Setup](https://reactnative.dev/docs/set-up-your-environment).

2. **Clone the repository:**

```bash
git clone https://github.com/dynamic-labs/react-native-expo.git
cd react-native-expo
```

2. **Install dependencies:**
3. **Install dependencies:**

```bash
npm install
```

3. **Set up your Dynamic environment ID:**
4. **(Optional) Configure a `.env` File with Your Dynamic Environment ID:**

```bash
EXPO_PUBLIC_ENVIRONMENT_ID=<dynamic project environment id>
```

4. **Start the application:**
5. **Start the application:**

iOS

```bash
npm run ios
```

Having trouble running the iOS simulator? Check out the [iOS Troubleshooting](./docs/ios-troubleshooting.md) guide.

Android

```bash
Expand All @@ -58,10 +64,6 @@ For further development, you may find the following files relevant:

## Documentation

For more detailed information on integrating Dynamic with React Native, please refer to our official documentation: [Dynamic React Native Integration](#) (link to be updated).

## Disclaimer

Please note that our React Native package is currently in early alpha. It is subject to changes and might have limited functionalities. Feel free to provide feedback to help us improve future releases.
For more detailed information on integrating Dynamic with React Native, please refer to our official documentation: [Dynamic React Native Integration](https://docs.dynamic.xyz/react-native/introduction).

Thank you for trying out our example app!
2 changes: 1 addition & 1 deletion src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ViemExtension } from "@dynamic-labs/viem-extension";

const environmentId =
(process.env.EXPO_PUBLIC_ENVIRONMENT_ID as string) ||
"2762a57b-faa4-41ce-9f16-abff9300e2c9";
"eba2bd12-09b3-4c4d-ba16-4727c3c89a49";

if (!environmentId) {
throw new Error("EXPO_PUBLIC_ENVIRONMENT_ID is required");
Expand Down
Loading