Skip to content

atilafassina/quantum

Repository files navigation

Quantum

This template should help get you started developing with Tauri + Solid + TypeScript + TailwindCSS.

Caution

Tauri v2 is approaching stability fast, but it not yet considered ready for production use.

Cloning it 🐑

You can use the Template button on the GitHub UI and shallow clone this repository. Or, do it with degit:

npx degit atilafassina/quantum

Alternatively, good old git clone can also work. It's recommended to make a shallow clone so it doesn't bring entire repository history:

git clone --depth 1 https://github.com/atilafassina/quantum

Running 🚤

The snippets below use PNPM as the package manager and task runner, but Yarn, NPM, Bun, or Cargo should also work with the appropriate syntax.

🛟 Check the Tauri Docs for more guidance on building your app.

First step is always to install JavaScript dependencies from the root:

pnpm install

Desktop (MacOS, Linux, or Windows) 🖥️

Once the template is properly cloned, install Node.js dependencies and you can run the Tauri app.

pnpm tauri dev

iOS 🍎

Check the prerequisites for having iOS ready to run (MacOS only). Once that is done, let’s create the XCode project:

pnpm tauri ios init

If everything runs successfully (keep an eye for warnings on your terminal). You can start the development server:

pnpm tauri ios dev --open

This command will open XCode with your project, select the simulator and get ready to run.

Android 🤖

Android Studio and a few other steps will be required to get things up and running. Once that's done, you can initialize the project:

pnpm tauri android init

Open the Android Studio, and run the development build:

pnpm tauri android dev

This command will open the Android Pixel simulator.

Suggested VSCode extensions 💡