https://github.com/jianxingxuejian/tauri-vue-template

A tauri project template, use Vue3 Typescript Vite4 UnoCSS
https://github.com/jianxingxuejian/tauri-vue-template

tauri template typescript unocss vite vue3

Last synced: 18 days ago
JSON representation

A tauri project template, use Vue3 Typescript Vite4 UnoCSS

• Host: GitHub
• URL: https://github.com/jianxingxuejian/tauri-vue-template
• Owner: jianxingxuejian
• License: mit
• Created: 2023-03-08T20:13:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-14T22:47:35.000Z (about 1 month ago)
• Last Synced: 2024-10-15T03:45:35.575Z (about 1 month ago)
• Topics: tauri, template, typescript, unocss, vite, vue3
• Language: TypeScript
• Homepage:
• Size: 360 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
tauri-vue-template


English | [简体中文](README_zh-CN.md)

This is a Tauri+Vue project template that I frequently use, built with [Vue3](https://github.com/vuejs/vue) + [Typescript](https://github.com/microsoft/TypeScript) + [Vite4](https://github.com/vitejs/vite) for the frontend.

## Features

- Atomic CSS framework [UnoCSS](https://github.com/unocss/unocss)，compatible with the syntax of [TailwindCSS](https://github.com/tailwindlabs/tailwindcss) and [WindiCSS](https://github.com/windicss/windicss)

- Use [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import)，[unplugin-vue-components](https://github.com/antfu/unplugin-vue-components)，[unplugin-icons](https://github.com/antfu/unplugin-icons), for zero import, on-demand use of common components, Vue functions, VueRouter, Pinia, and hundreds of thousands of Iconify icons.

- ESLint+Prettier for code style checking, lint-staged+ simple-git-hooks for hooks checking.

- Perfect workflow, including style checking, unit testing, build testing for both frontend and backend and release.

## Prerequisites

- Install **Rust** environment, download from the [official website](https://www.rust-lang.org/learn/get-started).

- Install **Node** environment, download from the [official website](https://nodejs.org).

- Install [Pnpm](https://pnpm.io), as the frontend package management tool.

- It is recommended to use the VSCode editor. The project has configured the plugins and some recommended settings for VSCode.

## Quick start

```shell

// Clone the repository

git clone https://github.com/jianxingxuejian/tauri-vue-template

// Install dependencies

pnpm i

// Tauri development mode

pnpm tauri dev

// Open VueDevTools

pnpm devtools

// Build, if you need a console in the packaged version, add the --debug parameter

pnpm tauri build

```

## Compilation and release

All pushes and PRs will trigger frontend/backend Lint checks, unit tests, and build tests based on the submitted files.

Tauri is cross-platform, but compilation can only be done on the respective platform. When you push the version tag, the release workflow will be triggered to compile and package binary files for various platforms.

Before releasing a new version, you need to modify the version number in tauri.conf.json, and then push the new version tag to Github to trigger the workflow.

```shell

git tag vX.Y.Z

git push origin vX.Y.Z

```

## Contributions

Contributes are welcome to help improve this project.

## License

This project is licensed under the [MIT](https://github.com/jianxingxuejian/tauri-vue-template/blob/main/LICENSE) license.