Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aero25x/tauri-shadcn-vite-template
Just simple Tauri Shadcn Template based on React / Vite
https://github.com/aero25x/tauri-shadcn-vite-template
react shadcn shadcn-ui tauri tauri-react tauri-template tauri-vite template-react
Last synced: about 1 month ago
JSON representation
Just simple Tauri Shadcn Template based on React / Vite
- Host: GitHub
- URL: https://github.com/aero25x/tauri-shadcn-vite-template
- Owner: Aero25x
- Created: 2024-08-15T13:34:57.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T15:30:17.000Z (3 months ago)
- Last Synced: 2024-10-09T11:22:35.316Z (about 1 month ago)
- Topics: react, shadcn, shadcn-ui, tauri, tauri-react, tauri-template, tauri-vite, template-react
- Language: TypeScript
- Homepage: https://t.me/hidden_coding
- Size: 255 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://t.me/hidden_coding)
[](https://github.com/aero25x)
[](https://x.com/aero25x)
[](https://www.youtube.com/@flaming_chameleon)
# Tauri Shadcn Vite Template
[](https://github.com/Aero25x/tauri-shadcn-vite-template/blob/main/LICENSE)
[](https://github.com/Aero25x/tauri-shadcn-vite-template/issues)
[](https://github.com/Aero25x/tauri-shadcn-vite-template/stargazers)
This repository provides a starter template for building cross-platform desktop applications using **Tauri**, **Vite**, **React**, and **shadcn**. The template is designed to help you quickly set up a modern, secure, and lightweight desktop application with a great user interface.
## Features
- **Cross-platform Support**: Build applications for Windows, macOS, and Linux.
- **Lightweight & Secure**: Tauri ensures a small application size and enhanced security.
- **Fast Development**: Vite provides lightning-fast build times and a smooth developer experience.
- **Modern UI Components**: Styled with shadcn, offering a set of accessible, customizable UI components.
- **React-based UI**: Leverage React to build dynamic user interfaces.
## Technologies Used
- **[Tauri](https://tauri.app/)**: A framework for building tiny, fast, and secure desktop applications with web technologies.
- **[Vite](https://vitejs.dev/)**: A frontend build tool that provides fast development and optimized production builds.
- **[React](https://reactjs.org/)**: A popular JavaScript library for building user interfaces.
- **[shadcn](https://shadcn.dev/)**: A component library styled with Radix UI, tailored for modern web applications.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- **Node.js**: Version 14.x or later
- **Rust**: Required for Tauri development
- **yarn** or **npm**: For package management
## Installation
1. **Clone the repository**:
```bash
git clone https://github.com/Aero25x/tauri-shadcn-vite-template.git
cd tauri-shadcn-vite-template
```
2. **Install dependencies**:
If you use `yarn`:
```bash
yarn install
```
Or if you use `npm`:
```bash
npm install
```
3. **Run the application**:
For development:
```bash
yarn tauri dev
```
For production:
```bash
yarn tauri build
```
## Usage
This template is intended to be a starting point for your Tauri-based desktop applications. Here's how to get started:
1. **Start Developing**: After following the installation steps, you can start building your application by modifying the React components in the `src` directory.
2. **Build for Production**: When you're ready to distribute your application, run `yarn tauri build` to create a production-ready bundle.
## Project Structure
Here's a brief overview of the project's structure:
```
.
├── src/
│ ├── components/ # React components
│ ├── App.tsx # Main React app
│ └── main.tsx # Entry point for Vite
├── tauri.conf.json # Tauri configuration
├── package.json # Node.js dependencies and scripts
├── yarn.lock # Yarn lock file (or package-lock.json for npm)
└── README.md # Project documentation
```
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`).
6. Open a pull request.
Please make sure your code adheres to the project's coding standards.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/Aero25x/tauri-shadcn-vite-template/blob/main/LICENSE) file for more details.
## Acknowledgements
- Thanks to the Tauri, Vite, React, and shadcn teams for their amazing tools and frameworks.
[](https://t.me/hidden_coding)
[](https://github.com/aero25x)
[](https://x.com/aero25x)
[](https://www.youtube.com/@flaming_chameleon)