tauri/examples/api/README.md

823 B

API example

This example demonstrates Tauri's API capabilities using the @tauri-apps/api package. It's used as the main validation app, serving as the testbed of our development process. In the future, this app will be used on Tauri's integration tests.

App screenshot

Running the example

  • Install dependencies (Run inside of this folder tauri/examples/api/)
# with yarn
$ yarn
# with npm
$ npm install
  • Compile tauri go to root of the tauri repo and run

Linux / Mac:

# choose to install node cli (1)
sh .scripts/setup.sh

Windows:

./.scripts/setup.ps1
  • Compile the app (Run inside of this folder tauri/examples/api/)
# with yarn
$ yarn tauri dev
# with npm
$ npm run tauri dev
  • Run the app
$ ./src-tauri/target/release/app