shyam-chen/tauri-starter

🔗 A boilerplate for Native App with Tauri, Vue, and Tailwind on Vite.

Tauri Starter

🔗 A boilerplate for Native App with Tauri, Vue, and Tailwind on Vite.

🌈 View Demo: Live | Windows | macOS | Android | iOS

Source Code: Web-side | Native-side | Server-side

Table of Contents

• Getting Started
• Project Setup
• Key Features

Getting Started

Prerequisites:

• Node.js version 20
• PNPM version 8
• Tauri version 2

Get started with Tauri Starter.

# install dependencies
$ pnpm install

# dev server (in one terminal)
# the default is to run it on macOS
$ pnpm dev:mobile
# or
$ pnpm dev:desktop

# mock server (in another terminal)
$ pnpm mock

Or use barebones scaffolding for your new Tauri app

$ pnpm dlx degit Shyam-Chen/Starter-Templates/tauri my-tauri-app

Project Setup

Follow steps to execute this boilerplate.

Web

Please refer to the upstream repository.

Windows/macOS

$ pnpm tauri dev

$ pnpm tauri build

Android

$ cd Library/Android/sdk/ndk/
$ ls
# 26.2.11394342

export NDK_HOME="$ANDROID_HOME/ndk/26.2.11394342"

$ pnpm tauri android init
$ pnpm tauri android dev
# select emulator

$ pnpm clean:android
$ pnpm tauri android init
$ pnpm tauri android build

iOS

$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
$ xcrun -f devicectl

$ pnpm tauri ios init
$ pnpm tauri ios dev
# select emulator

$ pnpm clean:ios
$ pnpm tauri ios init
$ pnpm tauri ios build

Key Features

This seed repository provides the following features:

• ---------- Essentials ----------
• Tauri - Native Apps Framework
• Vue - User Interface Framework
• Router - Routing
• Routes - File-based Routing
• Storer - State Management
• Formor - Form Validation
• Valibot - Schema Validation
• Localer - Internationalization and Localization
• Use - Composition Utilities
• Qrcode Image - QR Code Generation
• Lodash - JavaScript Utilities
• Date Fns - Date Utilities
• UnoCSS - CSS Utilities
• Iconify - Icon Utilities
• Tiptap - Rich Text Editor
• ECharts - Data Visualization
• ---------- Tools ----------
• Vite - Bundler
• TypeScript - JavaScript with Syntax for Types
• Sassy CSS - CSS Extension
• Biome - Formatter and Linter
• ESLint - Linter
• Prettier - Formatter
• Vitest - Test Runner
• WebdriverIO - Test Automation
• Appium - WebDriver Protocol Mobile Test Automation
• ---------- Environments ----------
• Node.js - JavaScript Runtime Environment
• Pnpm - Package Manager
• GitHub Actions - Continuous Integration and Delivery
• Tauri GitHub Action - Native Binary