Modern Desktop App Template

Last Updated: 2024-12-19

Tauri and React boilerplate for a modern desktop application. Not a project nor a substitute tutorial for my video tutorials. I didn't use yew (wasm) since its component libraries are not to the calibre of existing React component libraries.

Template Instructions

1. Have git installed
2. Download this repository and rename the folder to YOUR_APP or click "use this template" and clone your new repo that is referred to henceforth as YOUR_APP
3. Open YOUR_APP in an IDE
4. Follow environment instructions in SAMPLE_README.md
5. While you run pnpm install to install dependencies,
   • Modify productName, identifier, title found in src-tauri/tauri.conf.json
   • Modify authors in src-tauri/Cargo.toml
   • You can modify the header and the deafult footer by using Find feature in your IDE (const FOOTER = 'footerI18nKey';, HEADER_TITLE)
   • If you didn't click "use this template", remove the .git folder and reinitialize your own git repo
   • Delete or replace LICENSE.md since this template is public domain
   • Edit SAMPLE_README.md and replace README.md
6. Run pnpm dev to start developing
7. Read Tips and Trouble Shooting section of the new README.md
8. If any problems arise, open an issue or contact me

Ground-up Instructions

RSS of Commit History

Add https://github.com/elibroftw/modern-desktop-app-template/commits.atom to your RSS reader to stay up to date! I do not recommend pulling from my repo because you will need to edit the same files I reorganize

Tips

• Upgrading to Tauri v2

Screenshots

• The four views not found in boilerplate were added by yours truly. My About is the ViewExample provided in src
• Home view is purposely not translated since it's a filler

Future Resources

URL Schema (used with Single Instance)

The single instance plugin is already included in this template. Combine this plugin with the reading from below to get a Windows app URL protocol. This can be used for say Music Players, PDF Readers, etc.

• URL schema