tauri/examples/api/README.md

30 lines
663 B
Markdown
Raw Permalink Normal View History

# 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](./screenshot.png?raw=true)
## Running the example
- Compile Tauri
go to root of the Tauri repo and run:
```
pnpm i
pnpm build:debug
```
- Run the app in development mode (Run inside of this folder `examples/api/`)
```bash
$ pnpm tauri dev
```
- Build an run the release app (Run inside of this folder `examples/api/`)
```bash
$ pnpm tauri build
$ ../../target/release/api
```