You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-6Lines changed: 39 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,8 @@ npm install
78
78
79
79
#### Development Mode (Expo Go)
80
80
81
+
**Note**: Speech recognition features require a native build and cannot run in Expo Go. For full functionality, use native development mode (see below).
82
+
81
83
```bash
82
84
# Start the development server
83
85
npm start
@@ -91,19 +93,50 @@ Then:
91
93
- Press `a` for Android Emulator
92
94
- Scan QR code with Expo Go app on physical device
93
95
94
-
#### After Prebuild (Native Development)
96
+
#### Native Development (Required for Speech Recognition)
95
97
96
-
If you've run `npx expo prebuild` to generate native iOS/Android projects:
98
+
Speech recognition features require a native build. Follow these steps:
97
99
100
+
1.**Install dependencies and prebuild native code**:
98
101
```bash
99
-
# For iOS - this will start Metro and build/run the app
100
-
npx expo run:ios
102
+
# Install npm dependencies
103
+
npm install
104
+
105
+
# Generate native iOS/Android projects
106
+
# Use WITHOUT --clean to preserve existing Xcode project settings
107
+
# Only use --clean if you need a completely fresh start
108
+
npx expo prebuild
109
+
110
+
# For iOS, install CocoaPods dependencies
111
+
cd ios && pod install &&cd ..
112
+
```
113
+
114
+
**Important**:
115
+
- Use `npx expo prebuild` (without `--clean`) to preserve your existing Xcode project settings
116
+
- Only use `npx expo prebuild --clean` when you need a completely fresh native project (this will overwrite all custom settings)
117
+
- If you have custom Xcode settings, consider using [Expo config plugins](https://docs.expo.dev/guides/config-plugins/) to apply them programmatically
101
118
102
-
# For Android
119
+
2.**Run on a physical device** (speech recognition requires a physical device):
120
+
```bash
121
+
# For iOS - requires physical device connected
122
+
npx expo run:ios --device
123
+
124
+
# For Android - can use emulator or physical device
103
125
npx expo run:android
104
126
```
105
127
106
-
**Important**: After prebuild, always use `npx expo run:ios` or `npx expo run:android` rather than opening Xcode/Android Studio directly. This ensures Metro bundler is properly configured and the entry point resolves correctly.
128
+
**Important Notes**:
129
+
-**iOS Simulator does NOT support speech recognition** - you must use a physical iOS device
130
+
- After prebuild, always use `npx expo run:ios` or `npx expo run:android` rather than opening Xcode/Android Studio directly
131
+
- The app will gracefully degrade if microphone/speech permissions are denied - it will work normally without pronunciation checks
132
+
133
+
#### Permissions
134
+
135
+
The app requests the following permissions:
136
+
-**Microphone**: Required for speech recognition to help children practice pronunciation
137
+
-**Speech Recognition**: Required to validate pronunciation accuracy
138
+
139
+
Both permissions are optional - the app functions normally if permissions are denied, just without pronunciation validation features.
0 commit comments