tauri/examples/api
Caesar Schinas 5d89905e39
feat(api): add app-specific directory APIs, closes #5263 (#5272)
Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
2022-09-28 19:34:09 -03:00
..
dist feat(core): Expose "ignore_cursor_events" to Tauri and API (#5032) 2022-09-28 16:55:35 -03:00
isolation-dist refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
public refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
src feat(core): Expose "ignore_cursor_events" to Tauri and API (#5032) 2022-09-28 16:55:35 -03:00
src-tauri feat(api): add app-specific directory APIs, closes #5263 (#5272) 2022-09-28 19:34:09 -03:00
.gitignore refactor(examples/api): use vite (#2998) 2021-12-09 01:16:00 -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 fix(examples): use a less common port in API example, closes #5276 (#5277) 2022-09-28 11:10:12 -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 refactor: enhance api demo app mobile experience (#4929) 2022-08-14 18:39:35 -03:00
vite.config.js refactor(examples/api): new look (#4465) 2022-07-03 22:15:23 -03:00
yarn.lock chore(deps-dev): bump vite from 2.9.12 to 2.9.13 in /examples/api (#5103) 2022-09-02 20:57:37 -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