78 lines
1.6 KiB
Markdown
78 lines
1.6 KiB
Markdown
# TauriStarter
|
|
|
|
> Starter template for building desktop apps with Quasar (Vue 3), Vite, and Tauri
|
|
|
|
## Overview
|
|
|
|
TauriStarter is a ready-to-use template for cross-platform desktop applications. Combines the power of Vue 3 with Quasar's component library and Tauri's lightweight native runtime. Includes a build script for consistent dev/prod builds with logging.
|
|
|
|
## Features
|
|
|
|
- **Quasar Framework** - Vue 3 with Quasar components and utilities
|
|
- **Tauri Runtime** - Lightweight Rust-based native app shell
|
|
- **Build Script** - Consistent builds with dev/prod separation
|
|
- **Console Logging** - Frontend logs captured to files for debugging
|
|
- **Hot-Swappable Structure** - Standardized layout for component reuse
|
|
|
|
## Tech Stack
|
|
|
|
- **Frontend**: Quasar Framework (Vue 3) + Vite
|
|
- **Desktop**: Tauri (Rust)
|
|
- **State**: Pinia
|
|
- **Routing**: Vue Router
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+
|
|
- Rust (for Tauri)
|
|
- Xcode Command Line Tools (macOS)
|
|
|
|
### Development
|
|
|
|
```bash
|
|
cd app
|
|
npm install
|
|
|
|
# Web dev server
|
|
npm run dev
|
|
|
|
# Native app dev
|
|
npm run tauri:dev
|
|
```
|
|
|
|
### Building
|
|
|
|
```bash
|
|
cd app
|
|
|
|
# Dev build - opens app
|
|
./build.sh -dev -open
|
|
|
|
# Prod build - installs to ~/Applications
|
|
./build.sh -prod
|
|
|
|
# View console logs
|
|
./build.sh logs
|
|
|
|
# Clean build artifacts
|
|
./build.sh clean
|
|
```
|
|
|
|
## Customization
|
|
|
|
When using this template for a new project, update:
|
|
|
|
1. `app/src-tauri/tauri.conf.json` - productName, identifier, title
|
|
2. `app/package.json` - name, description
|
|
3. `app/build.sh` - APP_NAME, BUNDLE_ID_DEV, BUNDLE_ID_PROD
|
|
|
|
## Screenshots
|
|
|
|
<!-- Add screenshots to the screenshots/ folder -->
|
|
|
|
## Status
|
|
|
|
**Template** - Ready for use
|