tauri README

The project's README from github.com/tauri-apps/tauri. As one markdown file: README.md.

Tauri

status License test core FOSSA Status Chat Server website https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg support

Introduction

Tauri is a framework for building tiny, blazingly fast binaries for all major operating systems. Developers can integrate any front-end framework that compiles to HTML, JS and CSS for building their user interface. The backend of the application is a rust-sourced binary with an API that the front-end can interact with.

The user interface in Tauri apps currently leverages tao as a window handling library on macOS, Windows, Linux, Android and iOS. To render your application, Tauri uses WRY, a library which provides a unified interface to the system webview, leveraging WKWebView on macOS & iOS, WebView2 on Windows, WebKitGTK on Linux and Android System WebView on Android.

To learn more about the details of how all of these pieces fit together, please consult this ARCHITECTURE.md document.

Getting Started

If you are interested in making a tauri app, please visit the documentation website.

The quickest way to get started is to install the prerequisites for your system and create a new project with create-tauri-app. For example with npm:

npm create tauri-app@latest

Features

The list of Tauri's features includes, but is not limited to:

Platforms

Tauri currently supports development and distribution on the following platforms:

Platform Versions
Windows 7 and above
macOS 10.15 and above
Linux webkit2gtk 4.0 for Tauri v1 (for example Ubuntu 18.04). webkit2gtk 4.1 for Tauri v2 (for example Ubuntu 22.04).
iOS/iPadOS 9 and above
Android 7 and above (currently 8 and above)

Contributing

Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to stop by the Discord server and confirm with the team if it makes sense or if someone else is already working on it.

Please make sure to read the Contributing Guide before making a pull request.

Thank you to everyone contributing to Tauri!

Documentation

Documentation in a polyglot system is a tricky proposition. To this end, we prefer to use inline documentation in the Rust & JS source code as much as possible. Check out the hosting repository for the documentation site for further information: https://github.com/tauri-apps/tauri-docs

Partners

CrabNebula

For the complete list of sponsors please visit our website and Open Collective.

Organization

Tauri aims to be a sustainable collective based on principles that guide sustainable free and open software communities. To this end it has become a Programme within the Commons Conservancy, and you can contribute financially via Open Collective.

Licenses

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.

Logo: CC-BY-NC-ND

FOSSA Status

tauri (tauri-apps/tauri)

Searching Database…

112K ·GitHub
这是什么?Tauri 是一个用来构建体积小、速度极快的可执行程序的框架,支持所有主流操作系统,界面可以用任何能编译成 HTML、JS 和 CSS 的前端框架来编写。
它是怎么渲染界面的——会捆绑一个浏览器内核吗?不会——WRY 为 Tauri 提供了访问系统自带 WebView 的统一接口:macOS 和 iOS 上用 WKWebView,Windows 上用 WebView2,Linux 上用 WebKitGTK,Android 上用 Android System WebView,窗口则由 tao 负责。
创建一个新的 Tauri 应用最快的方法是什么?用 create-tauri-app 创建一个新项目——README 里以 npm 为例——然后跟着官方文档网站往下做就行。
用 Tauri 开发应用需要安装 Rust 吗?需要——Tauri 应用的后端是一个 Rust 程序,并向前端提供 API,所以必须装 Rust 工具链,另外还要装好系统 WebView 所需的依赖。
配置 Linux 构建有什么麻烦的地方吗?有——WebView 依赖包因大版本而异:Tauri v1 需要 webkit2gtk 4.0(比如 Ubuntu 18.04),而 v2 需要 webkit2gtk 4.1(比如 Ubuntu 22.04)。
我可以面向哪些平台构建和发布?Windows 7 及以上、macOS 10.15 及以上、Linux、iOS/iPadOS 9 及以上,以及 Android 7 及以上(目前要求 8 及以上)。
我用它开发自己的应用,许可证上有问题吗?代码采用 MIT 或 MIT/Apache 2.0 许可证(视具体情况而定),但 Tauri 的标志本身是 CC-BY-NC-ND,不能按同样的方式二次使用。
打包工具能生成哪些安装包格式?内置的应用打包器可以生成 .app、.dmg、.deb、.rpm 和 .AppImage 包,还有 Windows 安装程序:通过 NSIS 生成 .exe,通过 WiX 生成 .msi。
自动更新功能也能更新我的移动应用吗?不能——内置的自动更新只支持桌面端。
有针对 CI 或我编辑器的官方工具吗?有——Tauri 提供了一个用于简化 CI 的 GitHub action 和一个 VS Code 扩展。
加载界面的时候会启动一个 localhost 服务器吗?不会——Tauri 使用原生 WebView 协议,从不启动 localhost http(s) 服务器来提供 WebView 内容。
Creator
tauri-apps
Size
110 MB
Stars
112K
Age
7y
Commits · 90 Days