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

docs: Add a note of Expo Modules requirement in the docs #132

Merged
merged 1 commit into from
Mar 10, 2025
Merged
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
4 changes: 3 additions & 1 deletion docs/docs/fundamentals/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Installation is pretty straightforward, just use your favorite package manager.
</TabItem>
</Tabs>

If you're using bare React Native (instead of a managed Expo project), you also need to install Expo Modules because the underlying implementation relies on expo-file-system. Since expo-file-system is an Expo package, bare React Native projects need **Expo Modules** to properly integrate and use it. The link provided (https://docs.expo.dev/bare/installing-expo-modules/) offers guidance on setting up Expo Modules in a bare React Native environment.

If you plan on using your models via require() instead of fetching them from a url, you also need to add following lines to your `metro.config.js`:

```json
Expand All @@ -62,7 +64,7 @@ When using Expo, please note that you need to use a custom development build of
:::

:::caution
If you encountered an error that native modules for React Native Audio API were not installed, please make sure to install react-native-audio-api.
If you encountered an error that native modules for React Native Audio API were not installed, please make sure to install react-native-audio-api.
:::

:::info
Expand Down
Loading