Skip to content

Latest commit

 

History

History
119 lines (91 loc) · 5.25 KB

README.md

File metadata and controls

119 lines (91 loc) · 5.25 KB

⚡️ Tauri Start Solid

Contribution welcome Rust version Tauri version Repo Size

This project template should help get you started developing a multi-platform desktop application with tray menu support using Tauri, SolidJS, Nano Stores, Typescript, Tailwind CSS, and Vite.

Quick Start

pnpm dlx tiged riipandi/tauri-start-solid my-app
  1. Install required toolchains: Rust, Node.js, PNPM, and Lefthook.
  2. Replace the project name in the package.json, Cargo.toml, and tauri.conf.json files.
  3. Find and replace tauri-start-solid, tauri_start_solid and Tauri App strings in the source files.
  4. Set application identifier and other application metadata in tauri.conf.json file.
  5. Install frontend dependencies by running pnpm install.
  6. Run pnpm dev to start developing.

To build the application, run pnpm build. You can also run pnpm build:debug to build the application in debug mode, this will enable developer tools.

What's Inside?

  • Tauri v2 + essential plugins:
    • tauri-plugin-dialog
    • tauri-plugin-http
    • tauri-plugin-log
    • tauri-plugin-notification
    • tauri-plugin-os
    • tauri-plugin-positioner
    • tauri-plugin-process
    • tauri-plugin-shell
  • Custom titlebar (desktop)
  • Custom application menu
  • Application updater
  • Read values from .env file
  • Auto-generated Typescript types
  • Theme switcher (dark & light mode)
  • Application settings with separated window
  • Global state with persy key-value database as backend
  • Frontend app with SolidJS + Tailwind CSS
  • Frontend lint & format using Biome
  • Git hooks tasks with Lefthook
  • GitHub actions for CI testing and build

Recommended IDE Setup

Visual Studio Code + Recomended extensions

Fix Unsigned Warning (macOS)

Warning: "Tauri App" is damaged and can't be opened.

This warning is shown because the build is not signed. Run the following command to suppress this warning:

xattr -r -d com.apple.quarantine "/Applications/Tauri App.app"

Screenshots

Screenshot Screenshot

Acknowledgements

License

Licensed under either of Apache License 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Copyrights in this project are retained by their contributors.

See the LICENSE-APACHE and LICENSE-MIT files for more information.

🤫 Psst! If you like my work you can support me via GitHub sponsors.

Made by