https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind
『Tauri』Starter Vite template for React + Typescript + TailwindCSS + Prettier + ESLint build-in.
https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind
Last synced: 7 months ago
JSON representation
『Tauri』Starter Vite template for React + Typescript + TailwindCSS + Prettier + ESLint build-in.
- Host: GitHub
- URL: https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind
- Owner: RoyRao2333
- License: unlicense
- Created: 2023-09-20T08:35:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T06:25:15.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T19:36:16.958Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 482 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - template-tauri-vite-react-ts-tailwind - Template for Tauri + React + Typescript + TailwindCSS + Prettier + ESLint build-in. (Get Started / Templates)
- awesome-vite - template-tauri-vite-react-ts-tailwind - Template for Tauri + React + Typescript + TailwindCSS + Prettier + ESLint build-in. (Get Started / Templates)
README
template-tauri-vite-react-ts-tailwind
## Introduction
A starter [Vite](https://vitejs.dev/) template having:
- Vite
- Tauri
- React
- TypeScript
- Tailwind CSS
- Multiple eslint & prettier plugins installed
> **Note**
>
> This code repository may occasionally update its dependency versions. If the dependency versions in the latest code do not meet your expectations, please go to [Tags](https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind/tags) section to download a previous version of this template. I will display the dependencies used in each Tag, please choose the one you need.
>
> 这个代码仓库可能会不定期更新其依赖包的版本。如果最新代码中依赖的版本不符合你的期望，请移步[Tags](https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind/tags)下载之前的模板。每个Tag中使用的依赖都会展示在Tag详情中，请选择你需要的版本。
## Install
> This project uses [pnpm](https://pnpm.io/) as its package manager. Go check it out if you don't have it locally installed. If you use other package managers like *Yarn* or *npm*, you may need to change some scripts in `tauri.conf.json` and `package.json`.
Then you need a copy of this repository. You can [download](https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind/archive/refs/heads/main.zip) a copy as zip but [tiged](https://github.com/tiged/tiged) is recommended.
After you installed tiged, please excute the following command:
```sh
$ cd path-to-save-your-project
$ tiged royrao2333/template-tauri-vite-react-ts-tailwind your-project-name
```
After getting a copy of this repository, you can use your package manager to install dependecies:
```sh
$ cd path-to-your-project
$ pnpm install
```
## Usage
Let's run!
```sh
$ pnpm tauri dev
```
> We've already implemented some recommended configurations in ```.eslintrc.js```, ```.eslintignore```, ```.prettierrc.json5``` and ```.prettierignore```. Feel free to edit them if you have your own preferences.
## Related Efforts
- [Vite](https://github.com/vitejs/vite)
- [Tauri](https://github.com/tauri-apps/tauri)
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss)
## Contributing
Feel free to dive in! [Open an issue](https://github.com/RoyRao2333/template-tauri-vite-react-ts-tailwind/issues/new) or submit PRs.
## License
[MIT](LICENSE) © Roy Rao