marcson909 / template-app-base

Base desktop application code with Tauri, Native Web Components and SurrealDB (follow the VMES app architecture)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rust Base App Template for AWESOME-APP

Base desktop application code with Tauri, Native Web Components, and SurrealDB (follow the VMES app architecture)

See awesomeapp.org for more info

Discord Awesome App for any questions, issues, or anything else

Hot Reload dev

For hot-reload UI and Tauri development, run the following in your VSCode from this root folder:

awesome-app dev

IMPORTANT - Requires node.js v8 and above.

This assumes awesome-app was installed locally (e.g., cargo install awesome-app)

How it works

awesome-app dev will create an Awesome.toml which will be the list of commands it will run (format is self-explanatory).

You can run the commands manually if you want, or see below for list of commands.

We recommend using awesome-app dev but running each command manually might help troubleshoot.

Build manually

IMPORTANT: Make sure to have node.js 18 and above.

  • npm run tauri icon src-tauri/icons/app-icon.png - This will build the application icons.

  • npm run pcss - This will build the postcss files (src-ui/pcss/**/*.pcss).

  • npm run rollup - This will build and package the typescript files (src-ui/src/**/*.ts).

  • npm run localhost - This will run a localhost server with the dist/ folder as root (frontend hot reload)

  • In another terminal, npm tauri dev - Will start the Tauri build and start the process.


Troubleshooting

  • Make sure to have node.js 18 or above.
  • If some cryptic errors, run the command above one by one.
  • If npm tauri dev commands fail, try to do:
    • cd src-tauri
    • cargo build
    • This might be an important first step when using full surrealdb (i.e., with default features and not only kv-mem)



Happy Coding!

About

Base desktop application code with Tauri, Native Web Components and SurrealDB (follow the VMES app architecture)

License:Apache License 2.0


Languages

Language:TypeScript 43.6%Language:Rust 40.4%Language:CSS 14.0%Language:JavaScript 2.1%