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)

high-performance
Searching Database…

112K ·GitHub
Tauri
What is this?Tauri is a framework for building tiny, blazingly fast binaries for all major operating systems, letting you write the UI with any front-end framework that compiles to HTML, JS and CSS.
How does it render the UI — does it bundle a browser engine?No — WRY gives Tauri a unified interface to the system webview: WKWebView on macOS and iOS, WebView2 on Windows, WebKitGTK on Linux and Android System WebView on Android, with tao handling the windows.
What is the fastest way to create a new Tauri app?Scaffold a new project with create-tauri-app — the README shows npm as an example — and follow the documentation website from there.
Do I need to install Rust to build an app with it?Yes — the backend of a Tauri app is a Rust binary with an API the front-end interacts with, so a Rust toolchain is required, alongside your system's webview prerequisites.
Anything tricky about setting up the Linux build?Yes — the webview package differs by major version: Tauri v1 needs webkit2gtk 4.0 (e.g. Ubuntu 18.04), while v2 needs webkit2gtk 4.1 (e.g. Ubuntu 22.04).
Which platforms can I build and ship for?Windows 7 and above, macOS 10.15 and above, Linux, iOS/iPadOS 9 and above, and Android 7 and above (currently 8 and above).
Is the license fine if I build my own app with it?The code is MIT or MIT/Apache 2.0 where applicable, but the Tauri logo itself is CC-BY-NC-ND, so it cannot be reused the same way.
What installer formats can the bundler produce?The built-in app bundler creates .app, .dmg, .deb, .rpm and .AppImage bundles, plus Windows installers: .exe via NSIS and .msi via WiX.
Will the self-updater update my mobile app too?No — the built-in self updater is desktop only.
Is there official tooling for CI or my editor?Yes — Tauri ships a GitHub action for streamlined CI and a VS Code extension.
Does serving the UI involve a localhost server?No — Tauri uses a native WebView protocol and never creates a localhost http(s) server to serve the WebView contents.
What are similar projects?dsh_desktop, mygo, PakePlus-Win7, rayburst, Pake, spacedrive, PakePlus, dsh-launcher
Which topics is it in?bundler, webview, auto-update, notifications, vscode, installer, tauri, high-performance, github-actions, mobile-app, ios, rust
Creator
tauri-apps
Size
110 MB
Stars
112K
Updated
CommitOct 15Releasetauri-v3.0.0-alpha.5Oct 14
Age
7y
Commits · 90 Days