create-tauri-app-project-wind 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# create-tauri-app-project-wind
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A modern, professional desktop application starter template built with Tauri, React 18, TypeScript, and Shadcn UI. Features a custom title bar, responsive navigation, and comprehensive UI component showcase.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 🚀 Quick Start
|
|
6
6
|
|
|
7
7
|
### npm
|
|
8
8
|
|
|
@@ -31,20 +31,121 @@ pnpm install
|
|
|
31
31
|
pnpm tauri dev
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
## What's Included
|
|
34
|
+
## ✨ What's Included
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
- 🎨 **
|
|
41
|
-
-
|
|
42
|
-
- 💅 **TailwindCSS** - Utility-first
|
|
36
|
+
### Core Technologies
|
|
37
|
+
- ⚡ **Tauri** - Build smaller, faster, more secure desktop applications
|
|
38
|
+
- ⚛️ **React 18** - Modern React with hooks and concurrent features
|
|
39
|
+
- 📘 **TypeScript** - Full type safety across the entire application
|
|
40
|
+
- 🎨 **Shadcn UI** - 52+ beautiful, accessible UI components
|
|
41
|
+
- 🎯 **Vite** - Lightning-fast development with HMR
|
|
42
|
+
- 💅 **TailwindCSS** - Utility-first CSS framework
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
### Custom Features
|
|
45
|
+
- 🪟 **Custom Title Bar** - Native-like window controls (minimize, maximize, close)
|
|
46
|
+
- 🎨 **Theme System** - Light/Dark/System modes with live switching
|
|
47
|
+
- 📱 **Responsive Design** - Mobile-first approach with breakpoint handling
|
|
48
|
+
- 🍔 **Smart Navigation** - Hamburger menu on mobile, menubar on desktop
|
|
49
|
+
- 🎭 **Modern Animations** - Smooth transitions and interactive elements
|
|
50
|
+
- 🏗️ **Clean Architecture** - Pages, layouts, and components separation
|
|
45
51
|
|
|
46
|
-
|
|
52
|
+
## 🎨 UI Components
|
|
47
53
|
|
|
48
|
-
|
|
54
|
+
### Custom Components
|
|
55
|
+
- **TitleBar** - Custom window controls with draggable area
|
|
56
|
+
- Minimize, Maximize/Restore, Close buttons
|
|
57
|
+
- Integrated theme toggle with Sun/Moon icons
|
|
58
|
+
- Responsive hamburger menu (mobile)
|
|
59
|
+
- Desktop menubar (File, Edit, View, Help)
|
|
60
|
+
- About and Keyboard Shortcuts dialogs
|
|
49
61
|
|
|
50
|
-
|
|
62
|
+
### Shadcn UI Components (52+)
|
|
63
|
+
**Form & Input**: Button, Input, Textarea, Checkbox, Switch, Radio Group, Select, Input OTP, Form, Field, Input Group
|
|
64
|
+
|
|
65
|
+
**Navigation**: Menubar, Navigation Menu, Breadcrumb, Tabs, Pagination, Command
|
|
66
|
+
|
|
67
|
+
**Feedback**: Alert, Alert Dialog, Dialog, Toast/Sonner, Progress, Spinner, Skeleton, Badge
|
|
68
|
+
|
|
69
|
+
**Layout**: Card, Separator, Scroll Area, Resizable Panels, Aspect Ratio, Sheet
|
|
70
|
+
|
|
71
|
+
**Overlay**: Dropdown Menu, Context Menu, Popover, Hover Card, Tooltip, Drawer
|
|
72
|
+
|
|
73
|
+
**Data Display**: Table, Avatar, Calendar, Carousel, Accordion, Collapsible, Toggle, Toggle Group
|
|
74
|
+
|
|
75
|
+
## 🛠️ Project Structure
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
my-app/
|
|
79
|
+
├── src/
|
|
80
|
+
│ ├── components/
|
|
81
|
+
│ │ ├── ui/ # 52+ Shadcn UI components
|
|
82
|
+
│ │ ├── demo/ # Component showcase
|
|
83
|
+
│ │ ├── TitleBar.tsx # Custom window controls
|
|
84
|
+
│ │ └── theme-provider.tsx # Theme context
|
|
85
|
+
│ ├── layouts/
|
|
86
|
+
│ │ └── MainLayout.tsx # Main app layout wrapper
|
|
87
|
+
│ ├── pages/
|
|
88
|
+
│ │ └── Welcome.tsx # Welcome/demo page
|
|
89
|
+
│ └── lib/
|
|
90
|
+
│ └── utils.ts # Utility functions
|
|
91
|
+
├── src-tauri/
|
|
92
|
+
│ ├── src/main.rs # Rust backend
|
|
93
|
+
│ └── tauri.conf.json # Tauri configuration
|
|
94
|
+
└── package.json # Node dependencies
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## 📝 Available Scripts
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
# Development
|
|
101
|
+
npm run dev # Start Vite dev server (web preview)
|
|
102
|
+
npm run tauri dev # Run Tauri app in development mode
|
|
103
|
+
|
|
104
|
+
# Build
|
|
105
|
+
npm run build # Build frontend for production
|
|
106
|
+
npm run tauri build # Build complete desktop application
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## 🎯 Key Features
|
|
110
|
+
|
|
111
|
+
### Custom Title Bar
|
|
112
|
+
- Native-like window controls (minimize, maximize, close)
|
|
113
|
+
- Draggable area - Click and drag to move window
|
|
114
|
+
- Double-click to maximize
|
|
115
|
+
- Integrated theme toggle with Sun/Moon icons
|
|
116
|
+
- Responsive menu that adapts to screen size
|
|
117
|
+
|
|
118
|
+
### Responsive Navigation
|
|
119
|
+
**Desktop (≥768px)**: Traditional menubar with File, Edit, View, Help menus
|
|
120
|
+
|
|
121
|
+
**Mobile (<768px)**: Modern hamburger icon with smooth animation and slide-out navigation
|
|
122
|
+
|
|
123
|
+
### Theme System
|
|
124
|
+
- **Light Mode** - Clean, bright interface
|
|
125
|
+
- **Dark Mode** - Easy on the eyes
|
|
126
|
+
- **System Mode** - Auto-detects OS preference and updates live
|
|
127
|
+
|
|
128
|
+
## 📚 Documentation
|
|
129
|
+
|
|
130
|
+
For full documentation, examples, and advanced usage, visit:
|
|
131
|
+
|
|
132
|
+
🔗 [GitHub Repository](https://github.com/ssanaullahrais/project-wind-tauri-js-starter-kit)
|
|
133
|
+
|
|
134
|
+
## 🤝 Contributing
|
|
135
|
+
|
|
136
|
+
Contributions are welcome! Feel free to:
|
|
137
|
+
- Report bugs
|
|
138
|
+
- Suggest features
|
|
139
|
+
- Submit pull requests
|
|
140
|
+
|
|
141
|
+
## 📄 License
|
|
142
|
+
|
|
143
|
+
MIT License
|
|
144
|
+
|
|
145
|
+
## 🙏 Credits
|
|
146
|
+
|
|
147
|
+
Built with [Tauri](https://tauri.app/), [React](https://react.dev/), [Vite](https://vitejs.dev/), and [Shadcn UI](https://ui.shadcn.com/)
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
**Happy coding! 🚀**
|