feat: add bare React Native LLM chat example app

.cspell-wordlist.txt

@@ -21,6 +21,7 @@ microcontrollers
 notimestamps
 seqs
 smollm
+llms
 qwen
 XNNPACK
 EFFICIENTNET
@@ -108,3 +109,22 @@ sublist
 TTFT
 timestamping
 logprob
+RNFS
+pogodin
+kesha
+antonov
+rfdetr
+basemodule
+IMAGENET
+lraspp
+LRASPP
+worklet
+worklets
+BGRA
+RGBA
+DETR
+detr
+metaprogramming
+ktlint
+lefthook
+espeak

.cspell.json

@@ -1,7 +1,7 @@
 {
   "version": "0.2",
   "language": "en",
-  "ignorePaths": ["**/node_modules", "**/Pods"],
+  "ignorePaths": ["**/node_modules", "**/Pods", "**/readmes/**"],
   "dictionaryDefinitions": [
     {
       "name": "project-words",

.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directories:
+      - "/"
+      - "/packages/*"
+      - "/apps/*"
+      - "/docs"
+    schedule:
+      interval: "monthly"
+    groups:
+      security-updates:
+        applies-to: security-updates
+        patterns:
+          - "*"
+      all-updates:
+        applies-to: version-updates
+        patterns:
+          - "*"
+    ignore:
+      - dependency-name: "*"
+        update-types:
+          - "version-update:semver-patch"

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
         run: yarn lint
 
       - name: Typecheck files
-        run: yarn typecheck
+        run: yarn workspaces foreach --all --topological-dev run prepare && yarn typecheck
 
   build-library:
     runs-on: ubuntu-latest
@@ -35,7 +35,5 @@ jobs:
       - name: Setup
         uses: ./.github/actions/setup
 
-      - name: Build package
-        run: |
-          cd packages/react-native-executorch
-          yarn prepare
+      - name: Build all packages
+        run: yarn workspaces foreach --all --topological-dev run prepare

.gitignore

@@ -88,7 +88,15 @@ lib/
 ios/generated
 android/generated
 apps/*/ios/
+!apps/bare_rn/ios/
 apps/*/android/
+!apps/bare_rn/android/
+
+# generated TypeDoc API reference (regenerated at build time)
+docs/docs/06-api-reference/
+
+# integration test model assets
+packages/react-native-executorch/common/rnexecutorch/tests/integration/assets/models/
 
 # custom
 *.tgz

.nvmrc

@@ -1 +1 @@
-v20
+v22

README.md

@@ -38,20 +38,24 @@ React Native ExecuTorch bridges the gap between React Native and native platform
 [![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
 
 <details>
-<summary><strong> :blue_book: Table of Contents </strong></summary>
-
-- [:yin_yang: Supported Versions](#yin_yang-supported-versions)
-- [:earth_africa: Real-world Example](#earth_africa-real-world-example)
-- [:llama: Quickstart - Running Llama](#llama-quickstart---running-llama)
-- [:calling: Demo Apps](#calling-demo-apps)
-- [:robot: Ready-made Models](#robot-ready-made-models)
-- [:books: Documentation](#books-documentation)
-- [:balance_scale: License](#balance_scale-license)
-- [:soon: What's Next?](#soon-whats-next)
+<summary><strong>Table of Contents</strong></summary>
+
+- [Supported Versions](#supported-versions)
+- [Real-world Example](#real-world-example)
+- [Quickstart - Running Llama](#quickstart---running-llama)
+  - [:one: Installation](#one-installation)
+  - [:two: Setup \& Initialization](#two-setup--initialization)
+  - [:three: Run the Model!](#three-run-the-model)
+- [Demo Apps](#demo-apps)
+- [Ready-made Models](#ready-made-models)
+- [Documentation](#documentation)
+- [License](#license)
+- [What's Next?](#whats-next)
+- [React Native ExecuTorch is created by Software Mansion](#react-native-executorch-is-created-by-software-mansion)
 
 </details>
 
-## :yin_yang: Supported Versions
+## Supported Versions
 
 The minimal supported version are:
 * iOS 17.0
@@ -61,35 +65,50 @@ The minimal supported version are:
 > [!IMPORTANT]
 > React Native ExecuTorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
 
-## :earth_africa: Real-world Example
+## Real-world Example
 
 React Native ExecuTorch is powering [Private Mind](https://privatemind.swmansion.com/), a privacy-first mobile AI app available on [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) and [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
 
 <img width="2720" height="1085" alt="Private Mind promo" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
 
-## :llama: **Quickstart - Running Llama**
+## Quickstart - Running Llama
 
 **Get started with AI-powered text generation in 3 easy steps!**
 
-### :one: **Installation**
+### :one: Installation
 
 ```bash
 # Install the package
 yarn add react-native-executorch
+
+# If you use expo, please add these packages for resource fetching:
+yarn add @react-native-executorch/expo-resource-fetcher
+yarn add expo-file-system expo-asset
+
+#if you use bare React Native project use these packages:
+yarn add @react-native-executorch/bare-resource-fetcher
+yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
+
 # Depending on the platform, choose either iOS or Android
-yarn expo run:< ios | android >
+yarn < ios | android >
 ```
 
-### :two: **Setup & Initialization**
+### :two: Setup & Initialization
 
 Add this to your component file:
 
 ```tsx
 import {
   useLLM,
   LLAMA3_2_1B,
-  Message
+  Message,
+  initExecutorch,
 } from 'react-native-executorch';
+import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
+
+initExecutorch({
+  resourceFetcher: ExpoResourceFetcher,
+});
 
 function MyComponent() {
   // Initialize the model 🚀
@@ -98,7 +117,7 @@ function MyComponent() {
 }
 ```
 
-### :three: **Run the Model!**
+### :three: Run the Model!
 
 ```tsx
 const handleGenerate = async () => {
@@ -113,44 +132,39 @@ const handleGenerate = async () => {
 };
 ```
 
-## :calling: Demo Apps
+## Demo Apps
 
 We currently host a few example [apps](https://github.com/software-mansion/react-native-executorch/tree/main/apps) demonstrating use cases of our library:
 
 - `llm` - Chat application showcasing use of LLMs
 - `speech` - Speech to Text & Text to Speech task implementations
 - `computer-vision` - Computer vision related tasks
 - `text-embeddings` - Computing text representations for semantic search
+- `bare_rn` - LLM chat example for bare React Native (without Expo)
 
-If you would like to run demo app, navigate to its project directory and install dependencies with:
-
-```bash
-yarn
-```
-
-Then, depending on the platform, choose either iOS or Android:
+If you would like to run a demo app, navigate to its project directory. Then install dependencies and run app with:
 
 ```bash
-yarn expo run:< ios | android >
+yarn && yarn < ios | android >
 ```
 
 > [!WARNING]
 > Running LLMs requires a significant amount of RAM. If you are encountering unexpected app crashes, try to increase the amount of RAM allocated to the emulator.
 
-## :robot: Ready-made Models
+## Ready-made Models
 
 Our library has a number of ready-to-use AI models; a complete list is available in the documentation. If you're interested in running your own AI model, you need to first export it to the `.pte` format. Instructions on how to do this are available in the [Python API](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) and [optimum-executorch README](https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately).
 
-## :books: Documentation
+## Documentation
 
 Check out how our library can help you build your React Native AI features by visiting our docs:
 https://docs.swmansion.com/react-native-executorch
 
-## :balance_scale: License
+## License
 
 This library is licensed under [The MIT License](./LICENSE).
 
-## :soon: What's Next?
+## What's Next?
 
 To learn about our upcoming plans and developments, please visit our [milestones](https://github.com/software-mansion/react-native-executorch/milestones).
 

RELEASE.md

@@ -4,15 +4,15 @@
 
 The release process of new minor version consists of the following steps:
 
-1. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.0`.
-2. Update version tags in `packages/react-native-executorch/src/constants/modelUrls.ts` to point to the proper `MINOR` version and update tags on [🤗 huggingface](https://huggingface.co/software-mansion).
-3. Commit with a message 'Release v{MAJOR}.{MINOR}.0'. (We want to keep the latest `MINOR` version on the `main` branch.)
-4. Create a new release branch `release/{MAJOR}.{MINOR}`and push it to the remote.
-5. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process.
-6. Once all tests are passed, tag the release branch with proper version tag `v{MAJOR}.{MINOR}.0` and run `npm publish`.
-7. Create versioned docs by running from repo root `(cd docs && yarn docusaurus docs:version {MAJOR}.{MINOR}.x)` (the 'x' part is intentional and is not to be substituted). Also, make sure that all the links in `api-reference` are not broken.
-8. Create a PR with the updated docs.
-9. Create the release notes on GitHub.
+1. Update version tags in `packages/react-native-executorch/src/constants/modelUrls.ts` to point to the proper `MINOR` version and update tags on [🤗 huggingface](https://huggingface.co/software-mansion).
+2. Commit with a message 'Release v{MAJOR}.{MINOR}.0'.
+3. Create a new release branch `release/{MAJOR}.{MINOR}` and push it to the remote.
+4. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process.
+5. Once all tests are passed, tag the release branch with proper version tag `v{MAJOR}.{MINOR}.0` and run the [npm publish workflow](https://github.com/software-mansion/react-native-executorch/actions/workflows/npm-publish.yml).
+6. Create the release notes on GitHub.
+7. Bump version in `package.json` on the `main` branch to `v{MAJOR}.{NEXT_MINOR}.0` and commit with a message 'Bump version to v{MAJOR}.{NEXT_MINOR}.0'.
+8. Create versioned docs by running from repo root `(cd docs && yarn docs:version {MAJOR}.{MINOR}.x)` (the 'x' part is intentional and is not to be substituted). Also, make sure that all the links in `api-reference` are not broken.
+9. Create a PR with the updated docs.
 10. Update README.md with release video, if available.
 11. Update README.md links to release branch.
 
@@ -23,11 +23,11 @@ After the release branch is created and the version is published to npm we only
 > [!CAUTION]
 > Those changes should NOT include documentation changes, as they would be released automatically on the PR's merge and before the code changes are live. Instead create a separate PR with doc changes according to the [Docs update](#docs-update) section.
 
-1. Create a PR to the main branch.
-2. Once the PR is merged, `cherry-pick` the commit to the release branch.
-3. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
-   Commit with a message 'Release v{MAJOR}.{MINOR}.0'.
-4. Tag release branch with proper version tag `v{MAJOR}.{MINOR}.{REVISION}` and run `npm publish`.
+1. Create a PR with the fix to the `main` branch.
+2. Once the PR is merged, create a new branch off `release/{MAJOR}.{MINOR}`, cherry-pick the relevant commits from `main`, and open a PR targeting `release/{MAJOR}.{MINOR}`.
+3. Once the PR is merged, bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
+   Commit with a message 'Release v{MAJOR}.{MINOR}.{REVISION}'.
+4. Tag release branch with proper version tag `v{MAJOR}.{MINOR}.{REVISION}` and run the [npm publish workflow](https://github.com/software-mansion/react-native-executorch/actions/workflows/npm-publish.yml).
 5. Create release notes on GitHub.
 
 ## Docs update

apps/bare_rn/.bundle/config

@@ -0,0 +1,2 @@
+BUNDLE_PATH: "vendor/bundle"
+BUNDLE_FORCE_RUBY_PLATFORM: 1

apps/bare_rn/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  root: true,
+  extends: '@react-native',
+  parserOptions: {
+    requireConfigFile: false,
+  },
+};

apps/bare_rn/.gitignore

@@ -0,0 +1,80 @@
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+**/.xcode.env.local
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+*.hprof
+.cxx/
+*.keystore
+!debug.keystore
+.kotlin/
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/
+
+**/fastlane/report.xml
+**/fastlane/Preview.html
+**/fastlane/screenshots
+**/fastlane/test_output
+
+# Bundle artifact
+*.jsbundle
+
+# Ruby / CocoaPods
+**/Pods/
+/vendor/bundle/
+
+# Temporary files created by Metro to check the health of the file watcher
+.metro-health-check*
+
+# testing
+/coverage
+
+# Yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Custom
+!/ios/
+!/android/
+/assets/ai-models/

apps/bare_rn/.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  arrowParens: 'avoid',
+  singleQuote: true,
+  trailingComma: 'all',
+};

apps/bare_rn/.watchmanconfig

@@ -0,0 +1 @@
+{}