Expo Svelte
GitHub

You start where every SvelteKit app starts, with npx sv create:

Terminal
npx sv create my-app
yarn dlx sv create my-app
pnpm dlx sv create my-app
bunx sv create my-app

Then you install Expo Svelte and run one command that sets the project up. Expo Svelte's patches are pnpm's, so from here on the commands are pnpm's:

sh
cd my-app
pnpm add expo-svelte@next
pnpm exec expo-svelte init
pnpm android        # or: pnpm ios

The first pnpm android builds the native app, installs it on your phone or emulator and opens it. Edit src/routes/+mobile.svelte, save, and the app reloads with your change.

next is npm's tag for the newest release candidate.

Requirements

  • Node 24 LTS (24.3 or newer), Node 22.17 or newer, or Node 26 or newer. Not Node 25: React Native's tools refuse it, and pnpm add stops with ERR_PNPM_UNSUPPORTED_ENGINE (Troubleshooting).
  • pnpm 12.3.4 or newer. Expo Svelte's patches are applied by pnpm, so npm, Yarn and Bun won't do.
  • For Android: Android Studio with the Android SDK, a JDK 17, ANDROID_HOME set, and a phone with USB debugging or an emulator.
  • For iOS: a Mac with Xcode and CocoaPods, and a simulator or an iPhone.

The commands

npx sv create

Creates a SvelteKit project. Choose the minimal template, TypeScript, no add-ons, and pnpm. To skip the questions:

Terminal
npx sv create my-app --template minimal --types ts --no-add-ons --install pnpm
yarn dlx sv create my-app --template minimal --types ts --no-add-ons --install pnpm
pnpm dlx sv create my-app --template minimal --types ts --no-add-ons --install pnpm
bunx sv create my-app --template minimal --types ts --no-add-ons --install pnpm

pnpm add

Installs the library from the repository. pnpm prints a few warnings about peer dependencies, which the next command takes care of.

expo-svelte init

Turns the SvelteKit project into an Expo Svelte one. It prints a plan, makes the changes, runs pnpm install, and then runs expo-svelte doctor to check the result:

expo-svelte init: /home/you/my-app

  edit    package.json                       "main", svelte (the custom-renderer build), @sveltejs/kit 3.1.1 (exact: …), 8 dependencies, scripts, …
  edit    pnpm-workspace.yaml                overrides: expo-modules-core, @react-native/metro-config; patchedDependencies: @sveltejs/kit@3.1.1, …
  create  patches/expo-svelte/             6 patch files from the installed library
  create  metro.config.cjs                   withExpoSvelte(getDefaultConfig(__dirname))
  create  app.json                           my-app, dev.example.myapp
  edit    vite.config.ts                     expoSvelte() around SvelteKit's plugin, as a function of the mode
  create  src/lib/theme.ts                   light and dark colours for the native screens
  create  src/routes/+layout.mobile.svelte   the app shell
  create  src/routes/+mobile.svelte          a home screen
  create  src/routes/details/+mobile.svelte  a second screen
  edit    .gitignore                         .expo-svelte, .expo, /android, /ios

Run it as often as you like: a project that is set up gets Nothing to change. It never overwrites something you changed. When a file has a shape it can't edit safely, it leaves the file alone and prints the change for you to make. --dry-run shows the plan without writing anything. Project structure explains the files, and Configuration shows each change in full.

dev.example.myapp is a placeholder for the app's identifier. Pass --android-package and --ios-bundle-id, or edit app.json, before you publish.

pnpm android

Builds the native app, installs it on the connected phone or emulator, starts the development server (Metro) and opens the app. On a Mac, pnpm ios does the same for iOS.

The first build takes a while, because it compiles React Native and the library's native code. Later runs are faster, and most days you don't rebuild at all: Development builds explains when you need to.

When more than one device is connected, pick one with pnpm android --device <name>.

The web app

The web app is still there, and works as before:

sh
pnpm dev

It now compiles with the same Svelte build as the native app, and runs on SvelteKit 3.1.1.

Next steps

Type to search the guide.