Start your project off on the right foot.
The default tauri application setup works, but for larger projects it can become difficult.
This template uses cargo workspaces in order to allow the developer to seperate their rust code
into libraries, rather than packing it all into the src-tauri folder, as well as have more contorl
over their front-end code.
- React - Main library for building interactive stuff
- Vite - The build system.
- Tailwind - your css library.
- Shadcn/ui - Will probably kill off component libraries in the future.
- TypeScript - JavaScript with Types.
- pnpm - Better than npm, and probably yarn too.
- Tauri - Framework for building tiny, blazingly fast binaries for all desktop platforms.
- just - Modern cross-platform command runner, basically a better GNU make.
- Pre-configured
cippylints - Pre-configured
prettier - Pre-configured
eslint - Pre-configured debugging (check out the
.vscode/launch.json)
- To make the template yours, use ripgrep as so:
rg "tauri-template" --hidden. - Change every occurance of "tauri-template" to whatever your application name is.
- Start building.
A few tools will need to be installed first (assuming you have rust and node/npm installed)
- Install pnpm (A better package manager for node)
npm install -g pnpm - Install just (A modern cross-platform command runner, replaces GNU Makefiles)
cargo install just
Now you can set up the project
- Install dependences and compile
just setup - Run the desktop application in development mode
just dev
PRs accepted.
Small note: If editing the Readme, please conform to the standard-readme specification.