tauri/examples/api
renovate[bot] b6ed4ecb37
chore(deps) Update Rust crate syn to v2 (dev) (#7634)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
2023-11-13 08:20:19 -03:00
..
dist build(api.js): simplify output JS files (#8025) 2023-10-23 18:22:00 -03:00
isolation-dist refactor(core): use webview's URI schemes for IPC (#7170) 2023-08-10 10:12:38 -03:00
public refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
src feat(core): expose always_on_bottom, closes #7847 (#7933) 2023-10-18 09:47:24 -03:00
src-tauri chore(deps) Update Rust crate syn to v2 (dev) (#7634) 2023-11-13 08:20:19 -03:00
.gitignore chore(examples): ignore mobile artifacts on api example 2022-11-18 13:11:18 -03:00
.setup-cross.sh fix(cross): Fix docker image and cross setup (#8094) 2023-10-26 13:58:56 -03:00
.taurignore feat(cli): automatically use .taurignore, ref #4617 (#4623) 2022-07-28 18:58:38 -03:00
index.html refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
jsconfig.json refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives (#7942) 2023-10-17 09:40:20 -03:00
package.json refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives (#7942) 2023-10-17 09:40:20 -03:00
README.md docs(examples): add missing Readme and clarify existing (#3327) 2022-02-04 17:56:57 -03:00
screenshot.png fix(examples): icon transparency (#2450) 2021-08-16 13:01:53 -03:00
svelte.config.js refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives (#7942) 2023-10-17 09:40:20 -03:00
unocss.config.js chore: update license year (#6311) 2023-02-19 10:17:49 -03:00
vite.config.js fix(cli): invalid plugin template (#8161) 2023-11-07 22:56:21 -03:00
yarn.lock refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives (#7942) 2023-10-17 09:40:20 -03:00

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

  • Compile Tauri go to root of the Tauri repo and run: Linux / Mac:
# choose to install node cli (1)
bash .scripts/setup.sh

Windows:

./.scripts/setup.ps1
  • Install dependencies (Run inside of this folder examples/api/)
# with yarn
$ yarn
# with npm
$ npm install
  • Run the app in development mode (Run inside of this folder examples/api/)
# with yarn
$ yarn tauri dev
# with npm
$ npm run tauri dev
  • Build an run the release app (Run inside of this folder examples/api/)
$ yarn tauri build
$ ./src-tauri/target/release/app