Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.22 KB

README.md

File metadata and controls

61 lines (42 loc) · 2.22 KB
Raw

ch-desktop

Requirements

  • Rust
  • Node.js
  • Yarn (preferred by the Tauri team, so expect better compatibility)
  • For Linux users:
    • Follow this guide to install the system dependencies that are mandatory.
  • For Windows users:
  • For MacOS users:
    • XCode
    • The GNU C Compiler, installable via brew install gcc

Project setup

Install

yarn install

Don't need to install Rust dependencies, since running cargo commands like cargo run will automatically download and compile dependencies.

Run the app in dev mode

yarn tauri:serve

Since the project uses vue-cli-plugin-tauri, running tauri:serve will automatically run yarn serve beforehand, so the HTTP server is available when the Tauri apps is running.

Lints and fixes files

yarn lint
yarn pretty

Process to build for release/production

  1. Run yarn build to build your Vue app as static files in the dist/ directory.
  2. Run ./bin/tauri build (.\bin\tauri.exe build on Windows) to create the final binary in the src-tauri/target/release/ directory.

You could still use yarn tauri:build, but somehow it does not build the app the same way (there are some errors, feel free to drop an issue if you want to know more), and it combines a nodejs-installed version of the Tauri CLI binary, while we could just install it with Cargo. This breaks separation of concerns, so we do not recommend it.

Application icons

yarn icons

This will use the tauricon package to generate all application icons into the src-tauri/icons/ directory, based on the source icon located in src/assets/logo.png.

To update your logo, make sure your logo in src/assets/logo.png respects the following constraints:

  • Has to be BIG (the Tauri team actually recommends a 1240x1240 pixels wide logo!)
  • Must be in PNG format
  • Must contain an alpha layer for transparency (usually, black&white PNGs won't fit this requirement)