Lucas Nogueira e816a46b95 chore: update lock files 1 rok temu
..
dist a6b52e44f2 fix(tauri-utils): include `\n` in `io::read_line`, closes #6388 (#6519) 2 lat temu
isolation-dist 46e6187c89 chore: update license year (#6311) 2 lat temu
public 3fbaee454d refactor(examples/api): new look (#4465) 3 lat temu
src a6b52e44f2 fix(tauri-utils): include `\n` in `io::read_line`, closes #6388 (#6519) 2 lat temu
src-tauri e816a46b95 chore: update lock files 1 rok temu
.gitignore 7e3d672b9b chore(examples): ignore mobile artifacts on api example 2 lat temu
.setup-cross.sh 433dafa01a feat: add docker images for cross (#4702) 3 lat temu
.taurignore 596fa08d48 feat(cli): automatically use `.taurignore`, ref #4617 (#4623) 3 lat temu
README.md e57a303748 docs(examples): add missing Readme and clarify existing (#3327) 3 lat temu
index.html 3fbaee454d refactor(examples/api): new look (#4465) 3 lat temu
jsconfig.json f87c04d70b refactor(examples/api): use vite (#2998) 3 lat temu
package.json a6da7ef8af chore(deps-dev): bump vite from 2.9.13 to 2.9.16 in /examples/api (#7138) 2 lat temu
screenshot.png 126e18142f fix(examples): icon transparency (#2450) 4 lat temu
unocss.config.js 46e6187c89 chore: update license year (#6311) 2 lat temu
vite.config.js 46e6187c89 chore: update license year (#6311) 2 lat temu
yarn.lock a6da7ef8af chore(deps-dev): bump vite from 2.9.13 to 2.9.16 in /examples/api (#7138) 2 lat temu

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