22title : " Installing Core Kit SFA React Native SDK"
33sidebar_label : " Install"
44displayed_sidebar : sdk
5- description : " Web3Auth Core Kit Single Factor Auth React Native SDK - Install | Documentation - Web3Auth"
5+ description :
6+ " Web3Auth Core Kit Single Factor Auth React Native SDK - Install | Documentation - Web3Auth"
67---
78
89import TabItem from " @theme/TabItem" ;
@@ -15,22 +16,25 @@ In React Native, you have the choice to use one of the following workflows:
1516
1617### Expo Managed Workflow
1718
18- Your Expo app is built on your Expo's cloud, so you don't have control over the native modules used in the app. Developers build managed workflow apps
19- using ` expo-cli ` on their computers and a development client on their mobile devices. Managed workflow apps typically use one or more Expo services,
20- such as push notifications, builds, and updates.
19+ Your Expo app is built on your Expo's cloud, so you don't have control over the native modules used
20+ in the app. Developers build managed workflow apps using ` expo-cli ` on their computers and a
21+ development client on their mobile devices. Managed workflow apps typically use one or more Expo
22+ services, such as push notifications, builds, and updates.
2123
2224<ExpoWarning />
2325
2426### Bare React Native Workflow
2527
26- Your Bare React Native app is entirely built on your machine. In this workflow, the developer has complete control, along with the complexity that
27- comes with that. Configuration with ` app.json ` / ` app.config.js ` is mostly not supported in this context; instead, you will need to configure each
28- native project directly with Swift/Kotlin native modules. Check out the [ troubleshooting section] ( /sdk/pnp/react-native/install#troubleshooting ) for
29- fixing common issues.
28+ Your Bare React Native app is entirely built on your machine. In this workflow, the developer has
29+ complete control, along with the complexity that comes with that. Configuration with ` app.json ` /
30+ ` app.config.js ` is mostly not supported in this context; instead, you will need to configure each
31+ native project directly with Swift/Kotlin native modules. Check out the
32+ [ troubleshooting section] ( /sdk/pnp/react-native/install#troubleshooting ) for fixing common issues.
3033
3134:::tip
3235
33- You can read more about different workflows in the [ Expo documentation] ( https://docs.expo.dev/archive/managed-vs-bare/ ) .
36+ You can read more about different workflows in the
37+ [ Expo documentation] ( https://docs.expo.dev/archive/managed-vs-bare/ ) .
3438
3539:::
3640
@@ -44,8 +48,8 @@ npm install --save @web3auth/single-factor-auth-react-native
4448
4549### Adding a ` Storage ` Module
4650
47- Now with v4, we need to pass a ` Storage ` parameter to the SDK, which will be used for session management without storing the private keys of the user
48- in the device.
51+ Now with v4, we need to pass a ` Storage ` parameter to the SDK, which will be used for session
52+ management without storing the private keys of the user in the device.
4953
5054<Tabs
5155 defaultValue = " bare"
@@ -59,11 +63,11 @@ in the device.
5963
6064#### Expo Secure Store
6165
62- When using our SDK with an Expo-based React Native app (aka managed workflow), you have to install the ` expo-secure-store ` package as a ` Storage `
63- implementation.
66+ When using our SDK with an Expo-based React Native app (aka managed workflow), you have to install
67+ the ` expo-secure-store ` package as a ` Storage ` implementation.
6468
6569``` shell
66- expo install expo-secure-store
70+ npx expo install expo-secure-store
6771```
6872
6973</TabItem >
@@ -72,7 +76,8 @@ expo install expo-secure-store
7276
7377#### React Native Encrypted Storage
7478
75- When using our SDK with a bare workflow React Native app, you have to install a ` Storage ` implementation provided by react-native.
79+ When using our SDK with a bare workflow React Native app, you have to install a ` Storage `
80+ implementation provided by react-native.
7681
7782``` bash npm2yarn
7883npm install --save react-native-encrypted-storage
@@ -83,14 +88,15 @@ npm install --save react-native-encrypted-storage
8388
8489## Configuration
8590
86- After you have installed the files needed for your workflow, you'll have to configure the SDK with some additional steps to be able to use the SDK
87- properly.
91+ After you have installed the files needed for your workflow, you'll have to configure the SDK with
92+ some additional steps to be able to use the SDK properly.
8893
8994### Expo Managed Workflow
9095
9196- Adding URL scheme to ` app.json `
9297
93- To allow the Expo-based SDK to work with exported Expo Android apps, you need to add the designated scheme into ` app.json `
98+ To allow the Expo-based SDK to work with exported Expo Android apps, you need to add the designated
99+ scheme into ` app.json `
94100
95101``` json title="app.json"
96102{
@@ -102,13 +108,16 @@ To allow the Expo-based SDK to work with exported Expo Android apps, you need to
102108
103109:::tip
104110
105- You may refer to [ these example apps] ( /examples?product=Core+Kit&sdk=Single+Factor+Auth+React+Native+SDK ) and try it out yourself.
111+ You may refer to
112+ [ these example apps] ( /examples?product=Core+Kit&sdk=Single+Factor+Auth+React+Native+SDK ) and try it
113+ out yourself.
106114
107115:::
108116
109117### Bare React Native Workflow
110118
111- For the bare workflow, you need to perform additional installation steps, alongside specific configurations for Android and iOS separately.
119+ For the bare workflow, you need to perform additional installation steps, alongside specific
120+ configurations for Android and iOS separately.
112121
113122#### Android
114123
@@ -136,7 +145,8 @@ targetSdkVersion = 31
136145</intent-filter >
137146```
138147
139- - SDK version 31 requires you to explicitly define ` android:exported="true" ` in ` AndroidManifest.xml ` , check whether it is correctly present or not.
148+ - SDK version 31 requires you to explicitly define ` android:exported="true" ` in
149+ ` AndroidManifest.xml ` , check whether it is correctly present or not.
140150
141151``` xml title="android/app/src/main/AndroidManifest.xml"
142152<activity
@@ -166,14 +176,18 @@ pod install
166176
167177:::tip
168178
169- You may refer to ** [ these example apps] ( /examples?product=Core+Kit&sdk=Single+Factor+Auth+React+Native+SDK ) ** and try it out yourself.
179+ You may refer to
180+ ** [ these example apps] ( /examples?product=Core+Kit&sdk=Single+Factor+Auth+React+Native+SDK ) ** and try
181+ it out yourself.
170182
171183:::
172184
173185## Troubleshooting
174186
175187### Bundler Issues: Missing Dependencies
176188
177- You might face issues mentioning that certain dependencies are missing within the React Native environment. These are node dependencies that need to
178- be polyfilled in your application, to enable Web3Auth functionalities. Furthermore, your bundler needs to be reconfigured to use them while building
179- the app. Please check out our ** [ React Native Troubleshooting Guide] ( /troubleshooting/metro-issues ) **
189+ You might face issues mentioning that certain dependencies are missing within the React Native
190+ environment. These are node dependencies that need to be polyfilled in your application, to enable
191+ Web3Auth functionalities. Furthermore, your bundler needs to be reconfigured to use them while
192+ building the app. Please check out our
193+ ** [ React Native Troubleshooting Guide] ( /troubleshooting/metro-issues ) **
0 commit comments