Jacob e57a303748 docs(examples): add missing Readme and clarify existing (#3327)		3 年前
..
dist	0d1e3219b4 Merge branch 'next' into feat/audit-patches	3 年前
isolation-dist	d5d6d2abc1 Isolation Pattern (#43)	3 年前
public	4143ffd427 fix(cli.js): detect `CARGO_TARGET_DIR` for local run (#3147)	3 年前
src	0d1e3219b4 Merge branch 'next' into feat/audit-patches	3 年前
src-tauri	c6ba7f6524 fix(ci): update lockfiles	3 年前
.gitignore	f87c04d70b refactor(examples/api): use vite (#2998)	3 年前
README.md	e57a303748 docs(examples): add missing Readme and clarify existing (#3327)	3 年前
index.html	4143ffd427 fix(cli.js): detect `CARGO_TARGET_DIR` for local run (#3147)	3 年前
jsconfig.json	f87c04d70b refactor(examples/api): use vite (#2998)	3 年前
package.json	f87c04d70b refactor(examples/api): use vite (#2998)	3 年前
screenshot.png	126e18142f fix(examples): icon transparency (#2450)	4 年前
vite.config.js	f87c04d70b refactor(examples/api): use vite (#2998)	3 年前
yarn.lock	2212bd5d75 fix: dialog default path on Linux, closes #3091 (#3123)	3 年前

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.

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
```

README.md

API example

Running the example