Update docs and add taskfile

Author: davidliu

README.md

@@ -1,50 +1,35 @@
-# Welcome to your Expo app 👋
+<img src="./.github/assets/app-icon.png" alt="Voice Assistant App Icon" width="100" height="100">
 
-This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
+# React-Native Voice Assistant
 
-## Get started
+This is a starter template for [LiveKit Agents](https://docs.livekit.io/agents/overview/) that provides a simple voice interface using the [LiveKit React-Native SDK](https://github.com/livekit/client-sdk-react-native) and [Expo Plugin](https://github.com/livekit/client-sdk-react-native-expo-plugin).
 
-1. Install dependencies
+This template is free for you to use or modify as you see fit.
 
-   ```bash
-   npm install
-   ```
+## Getting started
 
-2. Start the app
+The easiest way to get this app running is with the [Sandbox for LiveKit Cloud](https://cloud.livekit.io/projects/p_/sandbox) and the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup/).
 
-   ```bash
-    npx expo start
-   ```
+First, create a new [Sandbox Token Server](https://cloud.livekit.io/projects/p_mytc7vpzfkt/sandbox/templates/token-server) for your LiveKit Cloud project.
 
-In the output, you'll find options to open the app in a
-
-- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
-- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
-- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
-- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
-
-You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
-
-## Get a fresh project
-
-When you're ready, run:
+Then, run the following command to automatically clone this template and connect it to LiveKit Cloud:
 
 ```bash
-npm run reset-project
+lk app create --template voice-assistant-react-native --sandbox <token_server_sandbox_id>
 ```
 
-This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
+Afterwards, run `npx expo install` to install dependencies,
+and then `npx expo start` from the command line to run the app. You can also use `npx expo run:android` or `npx expo run:ios` to run the app on the respective devices.
 
-## Learn more
+You'll also need an agent to speak with. Try our sample voice assistant agent for [Python](https://github.com/livekit-examples/voice-pipeline-agent-python), [Node.js](https://github.com/livekit-examples/voice-pipeline-agent-node), or [create your own from scratch](https://docs.livekit.io/agents/quickstart/).
 
-To learn more about developing your project with Expo, look at the following resources:
+> [!NOTE]
+> To setup without the LiveKit CLI, clone the repository and edit the `useConnectionDetails.ts` file to add either a `sandboxID` (if using a [Sandbox Token Server](https://cloud.livekit.io/projects/p_/sandbox/templates/token-server)), or a [manually generated](#token-generation) URL and token.
 
-- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
-- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
+## Token generation
 
-## Join the community
+In a production environment, you will be responsible for developing a solution to [generate tokens for your users](https://docs.livekit.io/home/server/generating-tokens/) which is integrated with your authentication solution. You should disable your sandbox token server and modify `TokenExt.kt` to use your own token server.
 
-Join our community of developers creating universal apps.
+## Contributing
 
-- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
-- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
+This template is open source and we welcome contributions! Please open a PR or issue through GitHub, and don't forget to join us in the [LiveKit Community Slack](https://livekit.io/join-slack)!

app.json

@@ -9,14 +9,26 @@
     "userInterfaceStyle": "automatic",
     "newArchEnabled": true,
     "ios": {
-      "supportsTablet": true
+      "supportsTablet": true,
+      "bitcode": false,
+      "bundleIdentifier": "io.livekit.voiceassistantreactnative",
     },
     "android": {
       "adaptiveIcon": {
         "foregroundImage": "./assets/images/adaptive-icon.png",
         "backgroundColor": "#ffffff"
       },
-      "package": "io.livekit.voiceassistantreactnative"
+      "package": "io.livekit.voiceassistantreactnative",
+      "permissions": [
+        "android.permission.ACCESS_NETWORK_STATE",
+        "android.permission.CAMERA",
+        "android.permission.INTERNET",
+        "android.permission.MODIFY_AUDIO_SETTINGS",
+        "android.permission.RECORD_AUDIO",
+        "android.permission.SYSTEM_ALERT_WINDOW",
+        "android.permission.WAKE_LOCK",
+        "android.permission.BLUETOOTH"
+      ]
     },
     "web": {
       "bundler": "metro",
@@ -25,7 +37,7 @@
     },
     "plugins": [
       "expo-router",
-      "@livekit/react-native-expo-plugin", 
+      "@livekit/react-native-expo-plugin",
       "@config-plugins/react-native-webrtc",
       [
         "expo-splash-screen",

package-lock.json

@@ -9,7 +9,9 @@
     "ios": "expo run:ios",
     "web": "expo start --web",
     "test": "jest --watchAll",
-    "lint": "expo lint"
+    "ci:test": "jest",
+    "lint": "expo lint",
+    "typescript": "tsc --noemit -p tsconfig.json"
   },
   "jest": {
     "preset": "jest-expo"
@@ -45,7 +47,8 @@
     "react-native-safe-area-context": "4.12.0",
     "react-native-screens": "~4.4.0",
     "react-native-web": "~0.19.13",
-    "react-native-webview": "13.12.5"
+    "react-native-webview": "13.12.5",
+    "typescript": "5.0.4"
   },
   "devDependencies": {
     "@babel/core": "^7.25.2",

package.json

@@ -0,0 +1,18 @@
+version: "3"
+output: interleaved
+dotenv: [".env.local"]
+
+tasks:
+  post_create:
+    desc: "Runs after this template is instantiated as a Sandbox or Bootstrap"
+    vars:
+      TOKEN_FILE: "hooks/useConnectionDetails.ts"
+    cmds:
+      - echo -e "Setting up sandbox..."
+      - platforms: [darwin]
+        cmd: sed -i "" "s/sandboxID = \"\"/sandboxID = \"{{.LIVEKIT_SANDBOX_ID}}\"/g" "{{.ROOT_DIR}}/{{.TOKEN_FILE}}"
+      - platforms: [linux, windows]
+        cmd: sed -i "s/sandboxID = \"\"/sandboxID = \"{{.LIVEKIT_SANDBOX_ID}}\"/g" "{{.ROOT_DIR}}/{{.TOKEN_FILE}}"
+      - echo -e "\nYour React-Native voice assistant is ready to go!\n"
+      - echo -e "To give it a try, run \"npx expo start\" to run the app."
+      - echo -e "\nFor more help view your project's README.md file or join our Slack community at https://livekit.io/join-slack."

taskfile.yml

@@ -2,6 +2,7 @@
   "extends": "expo/tsconfig.base",
   "compilerOptions": {
     "strict": true,
+    "moduleResolution": "bundler",
     "paths": {
       "@/*": [
         "./*"