Lucas Fernandes Nogueira 36e4837cea chore(examples): delete mobile.toml file (#6317) 2 år sedan
..
dist f6c3ea6faa chore: simplify windows_subsystem attribute (#6273) 2 år sedan
isolation-dist 46e6187c89 chore: update license year (#6311) 2 år sedan
public 3fbaee454d refactor(examples/api): new look (#4465) 3 år sedan
src 46e6187c89 chore: update license year (#6311) 2 år sedan
src-tauri 36e4837cea chore(examples): delete mobile.toml file (#6317) 2 år sedan
.gitignore 7e3d672b9b chore(examples): ignore mobile artifacts on api example 2 år sedan
.setup-cross.sh 433dafa01a feat: add docker images for cross (#4702) 3 år sedan
.taurignore 596fa08d48 feat(cli): automatically use `.taurignore`, ref #4617 (#4623) 3 år sedan
README.md e57a303748 docs(examples): add missing Readme and clarify existing (#3327) 3 år sedan
index.html 3fbaee454d refactor(examples/api): new look (#4465) 3 år sedan
jsconfig.json f87c04d70b refactor(examples/api): use vite (#2998) 3 år sedan
package.json 4c5a30370c fix(examples): use a less common port in API example, closes #5276 (#5277) 2 år sedan
screenshot.png 126e18142f fix(examples): icon transparency (#2450) 4 år sedan
unocss.config.js 46e6187c89 chore: update license year (#6311) 2 år sedan
vite.config.js 46e6187c89 chore: update license year (#6311) 2 år sedan
yarn.lock 8661e4a0d7 chore(deps): bump undici from 5.9.1 to 5.19.1 in /examples/api (#6296) 2 år sedan

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