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.

Sign up for GitHub

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

Added correct example app name #587

Merged
merged 2 commits into from
Dec 13, 2023
Merged

Added correct example app name #587

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dad885b
Added correct example app name
Dec 10, 2023
21d51dd
Removed unneeded whitespace.
Dec 10, 2023
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
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,29 @@ To get started with the project, run `yarn` in the root directory to install the
```sh
yarn
```

> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.

While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
If the installation fails with `xcrun: error: SDK "iphoneos"`, make sure [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12/) is installed, and the [Xcode command line tools are set correclty](https://stackoverflow.com/questions/68565356/xcrun-error-sdk-iphoneos-cannot-be-located).


While developing, you can run the [example app](/example-app/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.

To start the packager:

```sh
yarn example start
yarn example-app start
```

To run the example app on Android:

```sh
yarn example android
yarn example-app android
```

To run the example app on iOS:

```sh
yarn example ios
yarn example-app ios
```

Make sure your code passes TypeScript and ESLint. Run the following to verify:
Expand Down