From afb4f2f8961431d15e26cd28710eaa8f23adf7ca Mon Sep 17 00:00:00 2001 From: nothingismagick Date: Mon, 10 May 2021 20:39:24 +0200 Subject: [PATCH] chore(docs): add root-level ARCHITECTURE.md (#1766) * chore(docs): add root-level ARCHITECTURE.md Signed-off-by: Daniel Thompson-Yvetot * chore(readme): cleanup [skip ci] Signed-off-by: Daniel Thompson-Yvetot * chore(cli.js): update readme Signed-off-by: Daniel Thompson-Yvetot * chore(license): ship both apache and mit Signed-off-by: Daniel Thompson-Yvetot * chore(remove license): [skip ci] Signed-off-by: Daniel Thompson-Yvetot * chore(assimilation): we are now the borg Signed-off-by: Daniel Thompson-Yvetot * cleanup [skip ci] Co-authored-by: Lucas Nogueira --- ARCHITECTURE.md | 174 +++++++++++++++++++++++ README.md | 3 +- core/tauri/src/lib.rs | 4 +- package.json | 3 + tooling/api/package.json | 4 +- tooling/cli.js/LICENSE_APACHE-2.0 | 177 ++++++++++++++++++++++++ tooling/cli.js/{LICENSE => LICENSE_MIT} | 2 +- tooling/cli.js/README.md | 30 ++-- tooling/cli.js/package.json | 4 +- tooling/create-tauri-app/package.json | 3 +- 10 files changed, 377 insertions(+), 27 deletions(-) create mode 100644 ARCHITECTURE.md create mode 100644 tooling/cli.js/LICENSE_APACHE-2.0 rename tooling/cli.js/{LICENSE => LICENSE_MIT} (94%) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 000000000..903338325 --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,174 @@ +# The Tauri Architecture +https://tauri.studio +https://github.com/tauri-apps/tauri + +## Introduction +Tauri is a polyglot and generic system that makes it very composable. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that webviews can control the system via message passing. In fact, developers can extend the default API with their own functionality and bridge the Webview and Rust-based backend easily. + +Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime, since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task. + +## Major Components +The following section briefly describes the roles of the various parts of Tauri. +### Tauri Core [STABLE RUST] +#### [tauri](https://github.com/tauri-apps/tauri/tree/dev/core/tauri) +This is the glue crate that holds everything together. It brings the runtimes, macros, utilities and API into one final product. It reads the `tauri.conf.json` file at compile time in order to bring in features and undertake actual configuration of the app (and even the `Cargo.toml` file in the project's folder). It handles script injection (for polyfills / prototype revision) at runtime, hosts the API for systems interaction, and even manages updating. + +#### [tauri-build](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-build) +Apply the macros at build-time in order to rig some special features needed by `cargo`. + +#### [tauri-codegen](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-codegen) +- Embed, hash, and compress assets, including icons for the app as well as the system-tray. +- Parse `tauri.conf.json` at compile time and generate the Config struct. + +#### [tauri-macros](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-macros) +Create macros for the context, handler, and commands by leveraging the `tauri-codegen` crate. + +#### [tauri-runtime](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-runtime) +This is the glue layer between tauri itself and lower level webview libraries. + +#### [tauri-runtime-wry](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-runtime-wry) +This crate opens up direct systems-level interactions specifically for WRY, such as printing, monitor detection, and other windowing related tasks. `tauri-runtime` implementation for WRY. + +#### [tauri-utils](https://github.com/tauri-apps/tauri/tree/dev/core/tauri-utils) +This is common code that is reused in many places and offers useful utilities like parsing configuration files, detecting platform triples, injecting the CSP, and managing assets. + + +### Tauri Tooling +#### [api](https://github.com/tauri-apps/tauri/tree/dev/tooling/api) [TS -> JS] +A typescript library that creates `cjs` and `esm` Javascript endpoints for you to import into your Frontend framework so that the Webview can call and listen to backend activity. We also ship the pure typescript, because for some frameworks this is more optimal. It uses the message passing of webviews to their hosts. + +#### [bundler](https://github.com/tauri-apps/tauri/tree/dev/tooling/bundler) [RUST / SHELL] +The bundler is a library that builds a Tauri App for the platform triple it detects / is told. At the moment it currently supports macOS, Windows and Linux - but in the near future will support mobile platforms as well. May be used outside of Tauri projects. + +#### [cli.js](https://github.com/tauri-apps/tauri/tree/dev/tooling/cli.js) [JS] +Written in Typescript and packaged such that it can be used with `npm`, `pnpm`, and `yarn`, this library provides a node.js runner for common tasks when using Tauri, like `yarn tauri dev`. For the most part it is a wrapper around [cli.rs](https://github.com/tauri-apps/tauri/blob/dev/tooling/cli.rs). + +#### [cli.rs](https://github.com/tauri-apps/tauri/tree/dev/tooling/cli.rs) [RUST] +This rust executable provides the full interface to all of the required activities for which the CLI is required. It will run on macOS, Windows, and Linux. + +#### [create-tauri-app](https://github.com/tauri-apps/tauri/tree/dev/tooling/create-tauri-app) [JS] +This is a toolkit that will enable engineering teams to rapidly scaffold out a new tauri-apps project using the frontend framework of their choice (as long as it has been configured). + +## RUST API +- **app** The App API module allows you to manage application processes. +- **assets** The Assets module allows you to read files that have been bundled by tauri Assets handled by Tauri during compile time and runtime. +- **config** The Tauri config definition. +- **dialog** The Dialog API module allows you to show messages and prompt for file paths. +- **dir** The Dir module is a helper for file system directory management. +- **file** The File API module contains helpers to perform file operations. +- **http** The HTTP request API. +- **notification** The desktop notifications API module. +- **path** The file system path operations API. +- **process** Process helpers including the management of child processes. +- **rpc** The RPC module includes utilities to send messages to the JS layer of the webview. +- **shell** The shell api. +- **shortcuts** Global shortcuts interface. +- **version** The semver API. + + + +# External Crates +The Tauri-Apps organisation maintains two "upstream" crates from Tauri, namely TAO for creating and managing application windows, and WRY for interfacing with the Webview that lives within the window. + +## [TAO](https://github.com/tauri-apps/tao) +Cross-platform application window creation library in Rust that supports all major platforms like Windows, macOS, Linux, iOS and Android. Written in Rust, it is a fork of [winit](https://github.com/rust-windowing/winit) that we have extended for our own needs like menu bar and system tray. + + +## [WRY](https://github.com/tauri-apps/wry) +WRY is a cross-platform WebView rendering library in Rust that supports all major desktop platforms like Windows, macOS, and Linux. + +## [tauri-hotkey-rs](https://github.com/tauri-apps/tauri-hotkey-rs) +We needed to fix hotkey to work on all platforms, because upstream was not being responsive. + +# Additional tooling + +## [binary-releases](https://github.com/tauri-apps/binary-releases) +This is the delivery mechanism for tauri prebuilt binaries: currently the cli.rs (used by cli.js) and rustup binaries (used by the deps install command of cli.js). These artifacts are automatically created on release. + +## [tauri-action](https://github.com/tauri-apps/tauri-action) +This is a github workflow that builds tauri binaries for all platforms. It is not the fastest out there, but it gets the job done and is highly configurable. Even allowing you to create a (very basic) tauri app even if tauri is not setup. + +## [create-pull-request](https://github.com/tauri-apps/create-pull-request) +Because this is a very risky (potentially destructive) github action, we forked it in order to have strong guarantees that the code we think is running is actually the code that is running. + +## [vue-cli-plugin-tauri](https://github.com/tauri-apps/vue-cli-plugin-tauri) +This plugin allows you to very quickly install tauri in a vue-cli project. + +## [tauri-vscode](https://github.com/tauri-apps/tauri-vscode) +This project enhances the VS Code interface with several nice-to-have features. + +# Tauri Plugins [documentation](https://tauri.studio/en/docs/usage/guides/plugin) + +Generally speaking, plugins are authored by third parties (even though there may be official, supported plugins). A plugin generally does 3 things: +1. It provides rust code to do "something". +2. It provides interface glue to make it easy to integrate into an app. +3. It provides a JS API for interfacing with the rust code. + +Here are several examples of Tauri Plugins: +- https://github.com/tauri-apps/tauri-plugin-sql +- https://github.com/tauri-apps/tauri-plugin-stronghold +- https://github.com/tauri-apps/tauri-plugin-authenticator + +# Workflows +## What does the Development flow look like? +A developer must first install the prerequisite toolchains for creating a Tauri app. At the very least this will entail installing rust & cargo, and most likely also a modern version of node.js and potentially another package manager. Some platforms may also require other tooling and libraries, but this has been documented carefully in the respective platform docs. + +Because of the many ways to build front-ends, we will stick with a common node.js based approach for development. (Note: Tauri does not by default ship a node.js runtime.) + +The easiest way to do this is to run the following: +``` +npx create-tauri-app +``` + +Which will ask you a bunch of questions about the framework you want to install and then create everything you need in a single folder - some via the placement of template files and some through normal installation procedures of your framework. + +> If you don't use this process, you will have to manually install the tauri cli, initialise tauri and manually configure the `tauri.conf.json` file. + +Once everything is installed, you can run: +``` +yarn tauri dev +-or- +npm run tauri dev +``` +This will do several things: +1. start the JS Framework devserver +2. begin the long process of downloading and compiling the rust libraries +3. open an application window with devtools enabled +4. keep a long-lived console alive + +If you change your HTML/CSS/TS/JS, your framework devserver should give you its best shot at instant hot module reloading and you will see the changes instantly. + +If you modify your rust code or anything in the Cargo.toml, the window will close while rust recompiles. When finished it will reload. + +If you need to get deeper insight into your current project, or triage requires investigation of installed components, just run: + +``` +yarn tauri info +``` + + +## What does the Release flow look like? + +The release flow begins with proper configuration in the `tauri.conf.json` file. In this file, the developer can configure not only the basic behaviour of the application (like window size and decoration), they can also provide settings for signing and updating. + +Depending upon the operating system that the developer (or CI) is building the application on, there will be an app built for them for that system. (Cross compilation is not currently available, however there is an official [GitHub Action](https://github.com/tauri-apps/tauri-action) that can be used to build for all platforms.) + +To kick off this process, just: +``` +yarn tauri build +``` + +After some time, the process will end and you can see the results in the `./src-tauri/target/release` folder. + +## What does the End-User flow look like? +End users will be provided with binaries in ways that are appropriate for their systems. Whether macOS, Linux, or Windows, direct download or store installations - they will be able to follow procedures for installing and removing that they are used to. + +## What does the Updating flow look like? +When a new version is ready, the developer publishes the new signed artifacts to a server (that they have configured within `tauri.conf.json`). + +The application can poll this server to see if there is a new release. When there is a new release, the user is prompted to update. The application update is downloaded, verified (checksum & signature), updated, closed, and restarted. + +## License +Tauri itself is licensed under MIT or Apache-2.0. If you repackage it and modify any source code, it is your responsibility to verify that you are complying with all upstream licenses. Tauri is provided AS-IS with no explicit claim for suitability for any purpose. + +Here you may peruse our [Software Bill of Materials](https://app.fossa.com/projects/git%2Bgithub.com%2Ftauri-apps%2Ftauri). \ No newline at end of file diff --git a/README.md b/README.md index 1b1a4dc7b..beb362fe3 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,9 @@ Tauri Apps ## Introduction Tauri is a framework for building tiny, blazing fast binaries for all major desktop platforms. 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 [`winit`](https://docs.rs/winit) as a window handling library on macOS and Windows, and [`gtk`](https://gtk-rs.org/docs/gtk/) on Linux via the **Tauri-team** incubated and maintained [WRY](https://github.com/tauri-apps/wry), which creates a unified interface to the system webview, leveraging WebKit on macOS, WebView2 on Windows and WebKitGTK on Linux. +The user interface in Tauri apps currently leverages [`tao`](https://docs.rs/tao) as a window handling library on macOS and Windows, and [`gtk`](https://gtk-rs.org/docs/gtk/) on Linux via the **Tauri-team** incubated and maintained [WRY](https://github.com/tauri-apps/wry), which creates a unified interface to the system webview (and other goodies like Menu and Taskbar), leveraging WebKit on macOS, WebView2 on Windows and WebKitGTK on Linux. +To learn more about the details of how all of these pieces fit together, please consult this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document. ## Get Started If you are interested in making a tauri-app, please visit the [documentation website](https://tauri.studio). This README is directed towards those who are interested in contributing to the core library. But if you just want a quick overview about where `tauri` is at in its development, here's a quick burndown: diff --git a/core/tauri/src/lib.rs b/core/tauri/src/lib.rs index be8b0f85c..18f744264 100644 --- a/core/tauri/src/lib.rs +++ b/core/tauri/src/lib.rs @@ -5,9 +5,7 @@ //! Tauri is a framework for building tiny, blazing fast binaries for all major desktop platforms. //! 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 Cocoa/WebKit on macOS, gtk-webkit2 on Linux and MSHTML (IE10/11) or Webkit via Edge on Windows. -//! Tauri uses (and contributes to) the MIT licensed project that you can find at [webview](https://github.com/webview/webview). + #![warn(missing_docs, rust_2018_idioms)] #![cfg_attr(doc_cfg, feature(doc_cfg))] diff --git a/package.json b/package.json index 8d6caaffc..783c9fd78 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,9 @@ "version": "0.0.0", "license": "Apache-2.0 OR MIT", "private": true, + "contributors": [ + "Tauri Programme within The Commons Conservancy" + ], "repository": { "type": "git", "url": "https://github.com/tauri-apps/tauri.git", diff --git a/tooling/api/package.json b/tooling/api/package.json index 27fc11456..d021926d1 100644 --- a/tooling/api/package.json +++ b/tooling/api/package.json @@ -22,9 +22,7 @@ "url": "git+https://github.com/tauri-apps/tauri.git" }, "contributors": [ - "Tauri Team (https://tauri.studio)", - "Daniel Thompson-Yvetot ", - "Lucas Fernandes Gonçalves Nogueira " + "Tauri Programme within The Commons Conservancy" ], "license": "Apache-2.0 OR MIT", "bugs": { diff --git a/tooling/cli.js/LICENSE_APACHE-2.0 b/tooling/cli.js/LICENSE_APACHE-2.0 new file mode 100644 index 000000000..f433b1a53 --- /dev/null +++ b/tooling/cli.js/LICENSE_APACHE-2.0 @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/tooling/cli.js/LICENSE b/tooling/cli.js/LICENSE_MIT similarity index 94% rename from tooling/cli.js/LICENSE rename to tooling/cli.js/LICENSE_MIT index b2a2018a5..b08530d59 100644 --- a/tooling/cli.js/LICENSE +++ b/tooling/cli.js/LICENSE_MIT @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 - Present - Tauri Apps Contributors +Copyright (c) 2017 - Present Tauri Apps Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/tooling/cli.js/README.md b/tooling/cli.js/README.md index de4e9a953..434cfc3f8 100644 --- a/tooling/cli.js/README.md +++ b/tooling/cli.js/README.md @@ -1,8 +1,7 @@ -# tauri +# @tauri-apps/cli -## A fresh take on creating cross-platform apps. -[![status](https://img.shields.io/badge/Status-Early%20Alpha-yellow.svg)](https://github.com/quasarframework/quasar/tree/tauri) +[![status](https://img.shields.io/badge/Status-Beta-green.svg)](https://github.com/tauri-apps/tauri) [![Chat Server](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/SpmNs4S) [![devto](https://img.shields.io/badge/blog-dev.to-black.svg)](https://dev.to/tauri) @@ -13,31 +12,34 @@ [![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation) [![support](https://img.shields.io/badge/sponsor-Opencollective-blue.svg)](https://opencollective.com/tauri) - -Tauri is a tool for building tiny, blazing fast binaries for all major desktop platforms. You can use any front-end framework that compiles to HTML, JS and CSS for building your interface. - | Component | Version | | --------- | ------------------------------------------- | -| cli.js | ![](https://img.shields.io/npm/v/tauri.svg) | +| @tauri-apps/cli | ![](https://img.shields.io/npm/v/@tauri-apps/cli.svg) | +## About Tauri +Tauri is a polyglot and generic system that makes it very composable. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that webviews can control the system via message passing. In fact, developers can extend the default API with their own functionality and bridge the Webview and Rust-based backend easily. + +Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime, since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task. +## This module +Written in Typescript and packaged such that it can be used with `npm`, `pnpm`, and `yarn`, this library provides a node.js runner for common tasks when using Tauri, like `yarn tauri dev`. For the most part it is a wrapper around [cli.rs](https://github.com/tauri-apps/tauri/blob/dev/tooling/cli.rs). + +To learn more about the details of how all of these pieces fit together, please consult this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document. -Please visit the main readme for further information about contributing. ## Installation -The preferred method is to install this module locally as a dependency: +The preferred method is to install this module locally as a development dependency: ``` -$ npm install tauri -$ yarn add tauri +$ npm install --save-dev @tauri-apps/cli +$ yarn add --dev @tauri-apps/cli ``` ## Semver **tauri** is following [Semantic Versioning 2.0](https://semver.org/). - ## Licenses -Code: (c) 2015 - present - Daniel Thompson-Yvetot, Lucas Nogueira, Tensor, Boscop, Serge Zaitsev, George Burton and all the other amazing contributors. +Code: (c) 2015 - 2021 - The Tauri Programme within The Commons Conservancy. -MIT or MIT/Apache where applicable. +MIT or MIT/Apache 2.0 where applicable. Logo: CC-BY-NC-ND - Original Tauri Logo Designs by [Daniel Thompson-Yvetot](https://github.com/nothingismagick) and [Guillaume Chau](https://github.com/akryum) diff --git a/tooling/cli.js/package.json b/tooling/cli.js/package.json index 385c08eb8..2c933fa8e 100644 --- a/tooling/cli.js/package.json +++ b/tooling/cli.js/package.json @@ -32,9 +32,7 @@ "url": "git+https://github.com/tauri-apps/tauri.git" }, "contributors": [ - "Tauri Team (https://tauri.studio)", - "Daniel Thompson-Yvetot ", - "Lucas Fernandes Gonçalves Nogueira " + "Tauri Team (https://tauri.studio)" ], "license": "Apache-2.0 OR MIT", "bugs": { diff --git a/tooling/create-tauri-app/package.json b/tooling/create-tauri-app/package.json index 5821d7c65..a9cf9f9eb 100644 --- a/tooling/create-tauri-app/package.json +++ b/tooling/create-tauri-app/package.json @@ -12,8 +12,7 @@ }, "homepage": "https://github.com/tauri-apps/tauri#readme", "contributors": [ - "Tauri Team (https://tauri.studio)", - "Jacob Bolda (https://www.jacobbolda.com)" + "Tauri Programme within The Commons Conservancy" ], "main": "bin/create-tauri-app.js", "files": [