Home Explore Help
Register Sign In
root
/
tauri-workspace
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: feat/command-tests
Branches Tags
tauri-workspace
/
examples
/
api
Amr Bashir c94e1326a7 feat(bundler): add `nsis`, closes #4450, closes #2319 (#4674) 2 years ago
..
dist 00e1efaa9b feat: customize button texts of message dialog (#4383) 2 years ago
isolation-dist 3fbaee454d refactor(examples/api): new look (#4465) 3 years ago
public 3fbaee454d refactor(examples/api): new look (#4465) 3 years ago
src 4ab5545b7a feat: add content protection api, closes #5132 (#5513) 2 years ago
src-tauri c94e1326a7 feat(bundler): add `nsis`, closes #4450, closes #2319 (#4674) 2 years ago
.gitignore 7e3d672b9b chore(examples): ignore mobile artifacts on api example 2 years ago
.setup-cross.sh 433dafa01a feat: add docker images for cross (#4702) 3 years ago
.taurignore 596fa08d48 feat(cli): automatically use `.taurignore`, ref #4617 (#4623) 3 years ago
README.md e57a303748 docs(examples): add missing Readme and clarify existing (#3327) 3 years ago
index.html 3fbaee454d refactor(examples/api): new look (#4465) 3 years ago
jsconfig.json f87c04d70b refactor(examples/api): use vite (#2998) 3 years ago
package.json 4c5a30370c fix(examples): use a less common port in API example, closes #5276 (#5277) 2 years ago
screenshot.png 126e18142f fix(examples): icon transparency (#2450) 4 years ago
unocss.config.js 725236cea0 refactor: enhance api demo app mobile experience (#4929) 3 years ago
vite.config.js 3fbaee454d refactor(examples/api): new look (#4465) 3 years ago
yarn.lock 89af335156 chore(deps-dev): bump vite from 2.9.12 to 2.9.13 in /examples/api (#5103) 2 years ago

README.md

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