Skip to content
forked from agmmnn/tauri-ui

πŸ¦€ Create modern desktop applications with shadcn/ui, Tauri 2, Next.js 13, Tailwind.

License

Notifications You must be signed in to change notification settings

sessycode/tauri-ui

Β 
Β 

Repository files navigation

tauri-ui

Tauri UI Template

Tauri UI Template is a starting point for building modern desktop applications with web technologies. Customizable UI components with shadcn/ui, a lightweight and secure desktop app framework Tauri 2, the React-based framework Next.js 13, the utility-first CSS framework Tailwind.

You can download pre-built final bundles from the Releases section.

Getting Started

Use create-tauri-ui to quickly scaffold a Tauri UI project.

pnpm create tauri-ui

Or clone the repository:

gh repo clone agmmnn/tauri-ui
cd tauri-ui

pnpm i
pnpm tauri dev
pnpm tauri build

Features

tauri-ui

Next.js is used in this template to facilitate quick integration of the /examples directory of shadcn/ui. You can also easily use shadcn/ui with the React + Vite stack and any React router library (optionally) in Tauri.

Customization

The template can be customized by editing the following files:

Update Components

Note that shadcn/ui is not a library, therefore you will need to update the components manually. To do so, you can download the shadcn/ui/apps/www/components/ui directory and paste it into src/components/ui.

Folder Structure

.
β”œβ”€β”€ next-env.d.ts
β”œβ”€β”€ next.config.js    //nextjs config file https://nextjs.org/docs/pages/api-reference/next-config-js
β”œβ”€β”€ package.json
β”œβ”€β”€ postcss.config.js
β”œβ”€β”€ README.md
β”œβ”€β”€ public
β”œβ”€β”€ src               //frontend src:
β”‚   β”œβ”€β”€ app           //next.js appdir https://nextjs.org/docs/app/building-your-application/routing
β”‚   β”œβ”€β”€ assets
β”‚   β”œβ”€β”€ components    //from shadcn/ui
β”‚   β”‚   └── ui
β”‚   β”œβ”€β”€ data
β”‚   β”œβ”€β”€ hooks
β”‚   β”œβ”€β”€ lib
β”‚   └── styles
β”œβ”€β”€ src-tauri         //backend src:
β”‚   β”œβ”€β”€ build.rs
β”‚   β”œβ”€β”€ Cargo.lock
β”‚   β”œβ”€β”€ Cargo.toml    //https://doc.rust-lang.org/cargo/reference/manifest.html
β”‚   β”œβ”€β”€ icons         //https://tauri.app/v1/guides/features/icons/
β”‚   β”œβ”€β”€ src
β”‚   └── tauri.conf.json  //tauri config file https://next--tauri.netlify.app/next/api/config
β”œβ”€β”€ prettier.config.js     //prettier config file https://prettier.io/docs/en/configuration.html
β”œβ”€β”€ tailwind.config.js     //tailwind config file https://tailwindcss.com/docs/configuration
└── tsconfig.json          //typescript config file https://www.typescriptlang.org/docs/handbook/tsconfig-json.html

Recommended IDE Setup

About

πŸ¦€ Create modern desktop applications with shadcn/ui, Tauri 2, Next.js 13, Tailwind.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.5%
  • CSS 1.5%
  • Other 1.0%