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
Что это такое?Tauri — это фреймворк для сборки крошечных и очень быстрых приложений под все основные операционные системы: интерфейс можно писать на любом фронтенд-фреймворке, который компилируется в HTML, JS и CSS.
Как он отображает интерфейс — он встраивает браузерный движок?Нет — WRY даёт Tauri единый интерфейс к системному вебвью: WKWebView на macOS и iOS, WebView2 на Windows, WebKitGTK на Linux и Android System WebView на Android, а за окна отвечает tao.
Какой самый быстрый способ создать новое приложение на Tauri?Создайте новый проект с помощью create-tauri-app — в README в качестве примера показан npm — и дальше следуйте документации на сайте проекта.
Нужно ли устанавливать Rust, чтобы собрать приложение?Да — бэкенд приложения на Tauri это бинарник на Rust с API, с которым взаимодействует фронтенд, поэтому нужна инструментальная цепочка Rust, а также системные зависимости вебвью.
Есть ли подводные камни при сборке под Linux?Да — пакет вебвью зависит от мажорной версии: 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: .exe через NSIS и .msi через WiX.
Автообновитель обновит и моё мобильное приложение?Нет — встроенный самообновитель работает только на десктопе.
Есть ли официальные инструменты для CI или для моего редактора?Да — у Tauri есть GitHub action для удобного CI и расширение для VS Code.
Для работы интерфейса нужен локальный сервер (localhost)?Нет — Tauri использует нативный протокол WebView и никогда не поднимает localhost http(s)-сервер для отдачи содержимого WebView.
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