Installation

Requirements

iOS

• iOS 16.0+
• Xcode 15+
• Swift 5.9+
• XcodeGen: brew install xcodegen

Android

• Android 5.0+ (API 21+)
• Android Studio Ladybug+
• Android SDK API 35
• JDK 17 (bundled with Android Studio)

macOS

• macOS 15.0+
• Xcode 16+
• Swift 6.0+ toolchain

Shared

• Bun 1.3+ (required by the CLI build workflow)
• Node.js 20.19+ only when using npm/npx instead of bunx

For full platform setup instructions (emulator/simulator configuration, environment variables, etc.), see the iOS Setup, Android Setup, and macOS Setup guides.

Create a new project (recommended)

The fastest way to get started is with the managed workflow. The CLI currently scaffolds a complete project with native iOS and Android projects:

npx @thelacanians/vue-native-cli create my-app
cd my-app
bun install
vue-native dev --ios

You can also choose a template:

# Tab-based navigation
vue-native create my-app --template tabs

# Drawer navigation
vue-native create my-app --template drawer

The CLI scaffolds a full project with:

• Vue 3 app in app/
• iOS Xcode project in ios/
• Android Gradle project in android/
• Vite config with @thelacanians/vue-native-vite-plugin
• vue-native.config.ts for app configuration

macOS support is available through the native VueNativeMacOS package, but vue-native create does not scaffold a macOS app shell yet. Follow the macOS Setup guide to add a macOS target manually.

See the Managed Workflow guide for the full configuration reference and available CLI commands.

Manual setup

If you prefer to set up manually, install the packages:

bun add @thelacanians/vue-native-runtime
bun add -d @thelacanians/vue-native-vite-plugin @vitejs/plugin-vue vite

Then configure Vite:

// vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueNative from '@thelacanians/vue-native-vite-plugin'

export default defineConfig({
  plugins: [vue(), vueNative()],
})