Amr Bashir 7fb419c326 refactor: move to `muda` and `tray_icon` crates (#7535) 2 years ago
..
dist 7fb419c326 refactor: move to `muda` and `tray_icon` crates (#7535) 2 years ago
isolation-dist fbeb5b9185 refactor(core): use webview's URI schemes for IPC (#7170) 2 years ago
public 3fbaee454d refactor(examples/api): new look (#4465) 3 years ago
src 7fb419c326 refactor: move to `muda` and `tray_icon` crates (#7535) 2 years ago
src-tauri 7fb419c326 refactor: move to `muda` and `tray_icon` crates (#7535) 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 3788fb1476 chore(deps-dev): bump vite from 3.0.9 to 3.2.7 in /examples/api (#7223) 2 years ago
screenshot.png 126e18142f fix(examples): icon transparency (#2450) 4 years ago
unocss.config.js 46e6187c89 chore: update license year (#6311) 2 years ago
vite.config.js 1fd329935e Merge branch 'dev' into next 2 years ago
yarn.lock 3788fb1476 chore(deps-dev): bump vite from 3.0.9 to 3.2.7 in /examples/api (#7223) 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