-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit dc91293
Showing
69 changed files
with
6,000 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
node_modules | ||
|
||
# Output | ||
.output | ||
.vercel | ||
/.svelte-kit | ||
/build | ||
|
||
# OS | ||
.DS_Store | ||
Thumbs.db | ||
|
||
# Env | ||
.env | ||
.env.* | ||
!.env.example | ||
!.env.test | ||
|
||
# Vite | ||
vite.config.js.timestamp-* | ||
vite.config.ts.timestamp-* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
engine-strict=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Package Managers | ||
package-lock.json | ||
pnpm-lock.yaml | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"useTabs": true, | ||
"singleQuote": true, | ||
"trailingComma": "none", | ||
"printWidth": 100, | ||
"plugins": ["prettier-plugin-svelte"], | ||
"overrides": [ | ||
{ | ||
"files": "*.svelte", | ||
"options": { | ||
"parser": "svelte" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# Tauri 2 + Svelte 5 + Shadcn Boilerplate | ||
|
||
[![Tauri 2.0](https://img.shields.io/badge/Tauri-2.0-blue)](https://tauri.app/) | ||
[![Svelte 5](https://img.shields.io/badge/Svelte-5.0-orange)](https://svelte.dev/) | ||
[![Bun](https://img.shields.io/badge/Bun-ts-pink)](https://bun.sh/) | ||
[![shadcn-svelte](https://img.shields.io/badge/UI-shadcn--svelte-purple)](https://www.shadcn-svelte.com/) | ||
|
||
A modern, feature-rich boilerplate for building cross-platform desktop applications using Tauri 2, Svelte 5, and shadcn-svelte components. This template provides a solid foundation for developing performant desktop applications with a beautiful UI. | ||
|
||
## ✨ Features | ||
|
||
- 🚀 **Tauri 2.0** - Build smaller, faster, and more secure desktop applications | ||
- 🎯 **Svelte 5** - Cybernetically enhanced web apps with runes | ||
- 💅 **shadcn-svelte** - Beautiful and accessible UI components | ||
- 🎨 **TailwindCSS** - Utility-first CSS framework | ||
- 📦 **Bun** - Fast JavaScript runtime and package manager | ||
- 🔧 **TypeScript** - Type-safe development | ||
- 🎭 **Pre-configured development environment** | ||
|
||
## 🚀 Getting Started | ||
|
||
### Prerequisites | ||
|
||
Before you begin, ensure you have the following installed: | ||
|
||
1. **Bun** - [Bun installation](https://bun.sh/docs/installation) | ||
2. **Rust** - [Rust installation](https://www.rust-lang.org/tools/install) | ||
3. **For Windows Users:** | ||
- Install [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) | ||
- During installation, select "Desktop development with C++" workload | ||
|
||
### Installation | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/alysonhower/tauri2-svelte5-shadcn.git | ||
``` | ||
|
||
2. Navigate to the project directory: | ||
```bash | ||
cd tauri2-svelte5-shadcn | ||
``` | ||
|
||
3. Install dependencies: | ||
```bash | ||
bun install | ||
``` | ||
|
||
## 🛠️ Development | ||
|
||
### Start Development Server | ||
```bash | ||
bun run tauri dev | ||
``` | ||
|
||
### Build Production Release | ||
```bash | ||
bun run tauri build | ||
``` | ||
|
||
### Code Formatting | ||
```bash | ||
bun run format | ||
``` | ||
|
||
### Adding UI Components | ||
To add shadcn components (e.g., button): | ||
```bash | ||
bunx shadcn-svelte@latest add button | ||
``` | ||
|
||
## 📚 Usefull Links | ||
|
||
- [Svelte 5](https://svelte.dev/) | ||
- [Tauri 2](https://tauri.app/start/) | ||
- [TailwindCSS](https://tailwindcss.com/) | ||
- [Shadcn-svelte](https://next.shadcn-svelte.com/) | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions are welcome! Feel free to: | ||
|
||
1. Fork the repository | ||
2. Create a feature branch | ||
3. Submit a Pull Request | ||
|
||
Please ensure your PR follows the project's coding standards and includes appropriate tests. | ||
|
||
## ⚠️ Platform Support | ||
|
||
Currently tested and verified on: | ||
- ✅ Windows 11 |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"$schema": "https://next.shadcn-svelte.com/schema.json", | ||
"style": "default", | ||
"tailwind": { | ||
"config": "tailwind.config.ts", | ||
"css": "src/app.css", | ||
"baseColor": "slate" | ||
}, | ||
"aliases": { | ||
"components": "$lib/components", | ||
"utils": "$lib/utils", | ||
"ui": "$lib/components/ui", | ||
"hooks": "$lib/hooks" | ||
}, | ||
"typescript": true, | ||
"registry": "https://next.shadcn-svelte.com/registry" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"name": "tauri2-svelte5-shadcn", | ||
"version": "0.0.1", | ||
"type": "module", | ||
"scripts": { | ||
"dev": "vite dev", | ||
"build": "vite build", | ||
"preview": "vite preview", | ||
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", | ||
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch", | ||
"format": "prettier --write ./src", | ||
"lint": "prettier --check ./src", | ||
"tauri": "tauri" | ||
}, | ||
"devDependencies": { | ||
"@sveltejs/kit": "^2.7.4", | ||
"@sveltejs/vite-plugin-svelte": "^4.0.0", | ||
"@tailwindcss/typography": "^0.5.15", | ||
"autoprefixer": "^10.4.20", | ||
"bits-ui": "^1.0.0-next.40", | ||
"clsx": "^2.1.1", | ||
"prettier": "^3.3.3", | ||
"prettier-plugin-svelte": "^3.2.7", | ||
"svelte": "^5.1.9", | ||
"svelte-check": "^4.0.5", | ||
"tailwind-merge": "^2.5.4", | ||
"tailwind-variants": "^0.2.1", | ||
"tailwindcss": "^3.4.14", | ||
"tailwindcss-animate": "^1.0.7", | ||
"typescript": "^5.6.3", | ||
"vite": "^5.4.10", | ||
"@sveltejs/adapter-static": "^3.0.6", | ||
"@tauri-apps/cli": "^2.0.4", | ||
"bun-types": "^1.1.34", | ||
"lucide-svelte": "^0.454.0", | ||
"mode-watcher": "^0.4.1" | ||
}, | ||
"dependencies": {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
export default { | ||
plugins: { | ||
tailwindcss: {}, | ||
autoprefixer: {} | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Generated by Cargo | ||
# will have compiled files and executables | ||
/target/ | ||
/gen/schemas |
Oops, something went wrong.