NJS's Tauri + Svelte Kit Template

A nice and simple Tauri + Svelte Kit template to let me (or anyone else) quickly whip up new projects.

Features

• Tauri, a Rust-driven alternative to Electron.
• Svelte + Svelte Kit + TypeScript
• Vite
• Yarn for package management.
• Vitest for running JS/TS tests.
• ESLint and Prettier with some sensible defaults.
• Tailwind CSS + DaisyUI

VS Code Extensions

• Tauri
• rust-analyzer
• Svelte for VS Code
• JavaScript and TypeScript Nightly
• Tailwind CSS Intellisense
• ESLint
• Prettier
• markdownlint with some basic settings.
• Code Spell Checker
• Todo Tree
• Git History
• Git Graph

Coding style

This ESLint and Prettier config uses double-quotes and semicolons.

const msg = "wow";

Installation

You can download this repo as a .zip or clone it with git, but a cleaner approach is with degit.

npx degit njs-templates/tauri-svelte new-project
cd new-project
yarn

Recommended IDE

This was meant to be used with VS Code, but it should work with any editor. You'll be prompted to install any recommended extensions that aren't installed. If no one on your team is using VS Code, just delete the .vscode/ folder.

Next steps

• Install NodeJS, Yarn, and rustup if you haven't already. See Tauri prerequisites.
• Run yarn to install NPM packages.
• Run yarn tauri dev to run the app and make sure everything's working. The first time run might take a while to compile Rust packages.
• In package.json, change the project name and version.
• In src-tauri/Cargo.toml change the project name and version.
• In src-tauri/tauri.conf.json change the project name and version.
• Delete the following:
  • LICENSE.txt from the root of the directory.
    • If your project still uses an MIT License, just edit the author and year.
  • Either delete CHANGELOG.md or remove its contents.
  • The boilerplate from src/routes/+page.svelte, src/lib/components/HelloWorld.svelte and src/app.css.
    • You can easily do this from the Todo Tree tab in VS Code.
  • The .git/ folder if you cloned this repo.
• Run git init to start tracking changes.
• Do whatever. This code is yours now. Credit is appreciated but not needed.