Let's get going! 🐑

pnpm create quantum

npm create quantum

yarn create quantum

Running 🚤

Once scaffolding is done, you can cd into your project, install dependencies and start rocking! 🤘

The snippets below use PNPM as the package manager and task runner, but Yarn, NPM, Bun, or Cargo should also work with the appropriate syntax.

🛟 Check the Tauri Docs for more guidance on building your app.

First step is always to install JavaScript dependencies from the root:

pnpm install

Desktop (MacOS, Linux, or Windows) 🖥️

Once the template is properly cloned, install Node.js dependencies and you can run the Tauri app.

pnpm tauri dev

iOS 🍎

Check the prerequisites for having iOS ready to run (MacOS only). Once that is done, let’s create the XCode project:

pnpm tauri ios init

If everything runs successfully (keep an eye for warnings on your terminal). You can start the development server:

pnpm tauri ios dev --open

This command will open XCode with your project, select the simulator and get ready to run.

Android 🤖

Android Studio and a few other steps will be required to get things up and running. Once that's done, you can initialize the project:

pnpm tauri android init

Open the Android Studio, and run the development build:

pnpm tauri android dev

This command will open the Android Pixel simulator.

Continuous Integration and deployment

This template implements a GitHub Action workflow that builds and publishes the binaries for MacOS, Linux, and Windows. You can check the .github/workflows/release.yml file for more details. The draft and publishing of release happens through CrabNebula Cloud. To fully use this feature you will need to have a CrabNebula account and add the necessary secrets to your repository.

| Key | Description | | ------------------------------------ | ------------------------------------------------------------ | | CN_API_KEY | The API key for your CrabNebula account. | | CN_APP_SLUG | The slug of the app you want to publish. | | TAURI_SIGNING_PRIVATE_KEY | The private key used to sign the MacOS and Windows binaries. | | TAURI_SIGNING_PRIVATE_KEY_PASSWORD | The password for the private key. |

Besides those, in the tauri.conf.json it is also important to add a pubkey for the auto-updater.

Build Optimization ⚡

With a few opinionated defaults, Quantum enforces a smaller binary size than stock Tauri templates. Except for some special cases, these work particularly well.

• panic = "abort" The compiler will abort the program immediately when a panic occurs in production. Without performing any cleanup. Code will execute faster, the tradeoff is you won't get as much information about the panic when it occurs.

• codegen-units = 1 Explicitly tells the compiler to use only one code generation unit during compilation. Code generation units (CGUs) represent individual units of code that the compiler processes independently.

Reducing CGUs to a minimum will potentially reduces memory consumption and leads to faster compilation time. This setting hinders parallelization, so it's worth to benchmark in your particular app.

• lto = true Link Time Optimization (lto) enables the compiler to make more aggressive optimizations than it can do at the individual file level, resulting in potentially significant performance improvements in the final executable. However, enabling LTO may increase compilation times and require more memory during the linking phase, as the compiler needs to analyze and optimize a larger amount of code.

• opt-level = "s"

Specifying the optimization level to be "size-optimized." This option instructs the compiler to prioritize reducing the size of the generated code while still aiming for reasonable performance.

Using "s" is a balanced optimization. Some apps may find faster compilation times with opt-level="z", though this may bring slower runtime performance as a tradeoff.

• strip = true

Stripping symbols from generated code is generally recommended for release builds where binary size is a concern, and debuggability is less critical. It helps produce leaner binaries, which can be beneficial for deployment, distribution, or running in resource-constrained environments. Additionally, it can slightly enhance security because it makes the binaries harder to analyze.

Suggested VSCode extensions 💡

• Tauri
• rust-analyzer
• Tailwind CSS IntelliSense

Contributors