tauriv2-vue-desktop-starter

A desktop application starter using the libraries and technologies:

• Rust

  • Tauri v2 as the desktop application framework.
  • Tauri Store Plugin for persistence.

• Vue.js 3

  • Shadcn Vue + Tailwind CSS for components.
  • Vue Router for application routing.
  • Vue I18n for internationalization.
  • Pinia for state management.

Preview

Light mode dashboard view

Dark mode settings view

Language support view

Recommended IDE Setup

• VS Code + Volar + Tauri + rust-analyzer

Prerequisites

Follow Tauri's prerequisites guide to setup your development environment.

Then rename all instances of tauriv2-vue-desktop-starter and tauriv2_vue_desktop_starter to your app name.

If you want to replace the package manager update:

• The build configuration in tauri.conf.json
• Update the following steps in .github/workflows/publish-to-auto-release.yml:
  • Install pnpm
  • Install Node.js
  • Install frontend dependencies
• Update the following steps in .github/workflows/test-build-only.yml:
  • Install pnpm
  • Install Node.js
  • Install frontend dependencies

Installation

Install dependencies with pnpm install

Development

For Desktop development, run: pnpm tauri dev

Internationalization (i18n)

Vue I18n

Adding a new language

Create a new JSON file in the locales directory with the appropriate translations and the locale as the filename.

Then update the supportedLanguages function in lib/config.ts to include the new language.

Helpful Tips

Tauri Store Plugin stores settings.json at:

macOS: ~/Library/Application Support/com.github.tauriv2-vue-desktop-starter

App Icon

Tauri CLI provides an icon command pnpm tauri icon which takes an image path and generates icon files for your application.

Contributing

Contributions are welcome! Feel free to:

• Open issues for bugs or feature requests
• Submit pull requests for improvements
• Provide feedback on existing features
• Suggest documentation improvements
• Help with translations

Deployment & Release

Tauri v2 Deployment Guide

To build a binary, run:

pnpm tauri build

This repo is currently setup to create a release on Github when you merge to the release branch. See https://github.com/tauri-apps/tauri-action/tree/dev.

Caveats

If you are using the signing identity - for macOS, when you first download and run the application, you will have to go to System Settings > Privacy & Security and allow your app to run. See tauri-apps/tauri-action/issues/824 & support.apple.com/open-a-mac-app-from-an-unidentified-developer.