|
| 1 | +# Tauri 2 + Svelte 5 + Shadcn Boilerplate |
| 2 | + |
| 3 | +[](https://tauri.app/) |
| 4 | +[](https://svelte.dev/) |
| 5 | +[](https://bun.sh/) |
| 6 | +[](https://www.shadcn-svelte.com/) |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +## ✨ Features |
| 11 | + |
| 12 | +- 🚀 **Tauri 2.0** - Build smaller, faster, and more secure desktop applications |
| 13 | +- 🎯 **Svelte 5** - Cybernetically enhanced web apps with runes |
| 14 | +- 💅 **shadcn-svelte** - Beautiful and accessible UI components |
| 15 | +- 🎨 **TailwindCSS** - Utility-first CSS framework |
| 16 | +- 📦 **Bun** - Fast JavaScript runtime and package manager |
| 17 | +- 🔧 **TypeScript** - Type-safe development |
| 18 | +- 🎭 **Pre-configured development environment** |
| 19 | + |
| 20 | +## 🚀 Getting Started |
| 21 | + |
| 22 | +### Prerequisites |
| 23 | + |
| 24 | +Before you begin, ensure you have the following installed: |
| 25 | + |
| 26 | +1. **Bun** - [Bun installation](https://bun.sh/docs/installation) |
| 27 | +2. **Rust** - [Rust installation](https://www.rust-lang.org/tools/install) |
| 28 | +3. **For Windows Users:** |
| 29 | + - Install [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) |
| 30 | + - During installation, select "Desktop development with C++" workload |
| 31 | + |
| 32 | +### Installation |
| 33 | + |
| 34 | +1. Clone the repository: |
| 35 | +```bash |
| 36 | +git clone https://github.com/alysonhower/tauri2-svelte5-shadcn.git |
| 37 | +``` |
| 38 | + |
| 39 | +2. Navigate to the project directory: |
| 40 | +```bash |
| 41 | +cd tauri2-svelte5-shadcn |
| 42 | +``` |
| 43 | + |
| 44 | +3. Install dependencies: |
| 45 | +```bash |
| 46 | +bun install |
| 47 | +``` |
| 48 | + |
| 49 | +## 🛠️ Development |
| 50 | + |
| 51 | +### Start Development Server |
| 52 | +```bash |
| 53 | +bun run tauri dev |
| 54 | +``` |
| 55 | + |
| 56 | +### Build Production Release |
| 57 | +```bash |
| 58 | +bun run tauri build |
| 59 | +``` |
| 60 | + |
| 61 | +### Code Formatting |
| 62 | +```bash |
| 63 | +bun run format |
| 64 | +``` |
| 65 | + |
| 66 | +### Adding UI Components |
| 67 | +To add shadcn components (e.g., button): |
| 68 | +```bash |
| 69 | +bunx shadcn-svelte@latest add button |
| 70 | +``` |
| 71 | + |
| 72 | +## 📚 Usefull Links |
| 73 | + |
| 74 | +- [Svelte 5](https://svelte.dev/) |
| 75 | +- [Tauri 2](https://tauri.app/start/) |
| 76 | +- [TailwindCSS](https://tailwindcss.com/) |
| 77 | +- [Shadcn-svelte](https://next.shadcn-svelte.com/) |
| 78 | + |
| 79 | +## 🤝 Contributing |
| 80 | + |
| 81 | +Contributions are welcome! Feel free to: |
| 82 | + |
| 83 | +1. Fork the repository |
| 84 | +2. Create a feature branch |
| 85 | +3. Submit a Pull Request |
| 86 | + |
| 87 | +Please ensure your PR follows the project's coding standards and includes appropriate tests. |
| 88 | + |
| 89 | +## ⚠️ Platform Support |
| 90 | + |
| 91 | +Currently tested and verified on: |
| 92 | +- ✅ Windows 11 |
0 commit comments