https://github.com/elibroftw/modern-desktop-app-template

Tauri & ReactJS boilerplate for a modern desktop application. Not a project nor a substitute for my Tauri video tutorials.
https://github.com/elibroftw/modern-desktop-app-template

desktop-app gui javascript mantine react reactjs rust tauri template vite

Last synced: 22 days ago
JSON representation

Tauri & ReactJS boilerplate for a modern desktop application. Not a project nor a substitute for my Tauri video tutorials.

• Host: GitHub
• URL: https://github.com/elibroftw/modern-desktop-app-template
• Owner: elibroftw
• License: cc0-1.0
• Created: 2022-03-25T02:51:57.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-21T03:02:32.000Z (4 months ago)
• Last Synced: 2024-10-01T05:05:11.858Z (about 1 month ago)
• Topics: desktop-app, gui, javascript, mantine, react, reactjs, rust, tauri, template, vite
• Language: JavaScript
• Homepage: https://www.youtube.com/playlist?list=PLmWYh0f8jKSjt9VC5sq2T3mFETasG2p2L
• Size: 1.56 MB
• Stars: 185
• Watchers: 2
• Forks: 38
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-tauri - tauri-react-mantine-vite-template - React Mantine template featuring custom titlebar for Windows, auto publish action, auto update, and more. (Getting Started / Templates)

README

        
# Modern Desktop App Template

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`](https://git-scm.com/downloads) 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`](./SAMPLE_README.md)

5. While you run `pnpm install` to install dependencies,

    - Modify `productName, identifier, title` found in [`src-tauri/tauri.conf.json`](./src-tauri/tauri.conf.json)

    - Modify `authors` in [`src-tauri/Cargo.toml`](./src-tauri/Cargo.toml)

    - Modify `HEADER_TITLE, FOOTER` found in [`src/utils.js`](./src/utils.js)

    - 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](#tips) section of the new `README.md`

8. If any problems arise, open an issue or contact me

[Ground-up Instructions](https://tauri.app/v1/guides/getting-started/setup/)

## 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](/SAMPLE_README.md#tips-and-trouble-shooting)

## 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

![App screenshot with dark colorscheme](https://user-images.githubusercontent.com/21298211/209476561-5813ef56-21e6-4e64-91b5-53499ced1296.png "dark colorscheme")

![App screenshot with light colorscheme](https://user-images.githubusercontent.com/21298211/209476610-5599245b-59b1-4dcf-8dfa-a77fab0013b3.png "light colorscheme")

## 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](https://gitlab.com/ioneyed/tauri-example-singleinstance)