tauri/examples/api
Lucas Fernandes Nogueira 0d0501cb7b
refactor(clipboard): use arboard instead of tao closes #8177 (#8394)
* refactor(clipboard): use arboard instead of tao closes #8177

* update api lock

* add change file
2023-12-14 13:41:20 -03:00
..
dist fix(tauri-utils): include \n in io::read_line, closes #6388 (#6519) 2023-08-08 16:43:19 -03:00
isolation-dist chore: update license year (#6311) 2023-02-19 10:17:49 -03:00
public refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
src fix(tauri-utils): include \n in io::read_line, closes #6388 (#6519) 2023-08-08 16:43:19 -03:00
src-tauri refactor(clipboard): use arboard instead of tao closes #8177 (#8394) 2023-12-14 13:41:20 -03:00
.gitignore chore(examples): ignore mobile artifacts on api example 2022-11-18 13:11:18 -03:00
.setup-cross.sh feat: add docker images for cross (#4702) 2022-07-27 14:58:43 -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(examples/api): use vite (#2998) 2021-12-09 01:16:00 -03:00
package.json chore(deps-dev): bump vite from 2.9.13 to 2.9.16 in /examples/api (#7138) 2023-06-06 14:06:29 -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
unocss.config.js chore: update license year (#6311) 2023-02-19 10:17:49 -03:00
vite.config.js chore: update license year (#6311) 2023-02-19 10:17:49 -03:00
yarn.lock chore(deps-dev): bump vite from 2.9.13 to 2.9.16 in /examples/api (#7138) 2023-06-06 14:06:29 -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