Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ar10dev/tauri-solid-ts-tailwind-vite
Tauri + Solid + Tailwind CSS + TypeScript + Vite + ESLint + Prettier Starter template
https://github.com/ar10dev/tauri-solid-ts-tailwind-vite
eslint prettier rust solidjs starter-template tailwindcss tauri tauri-app tauri-starter template typescript vitejs
Last synced: 5 days ago
JSON representation
Tauri + Solid + Tailwind CSS + TypeScript + Vite + ESLint + Prettier Starter template
- Host: GitHub
- URL: https://github.com/ar10dev/tauri-solid-ts-tailwind-vite
- Owner: AR10Dev
- License: mit
- Created: 2021-10-22T12:35:57.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T11:24:57.000Z (5 days ago)
- Last Synced: 2024-10-31T12:25:58.377Z (5 days ago)
- Topics: eslint, prettier, rust, solidjs, starter-template, tailwindcss, tauri, tauri-app, tauri-starter, template, typescript, vitejs
- Language: JavaScript
- Homepage:
- Size: 3.18 MB
- Stars: 119
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Tauri](https://tauri.app) + [Solid](https://solidjs.com) + [Tailwind CSS](https://tailwindcss.com) + [TypeScript](https://typescriptlang.org) + [Vite](https://vitejs.dev) Starter
[//]:[](https://github.com/AR10Dev/tauri-solid-ts-tailwind-vite)
[](https://github.com/AR10Dev/tauri-solid-ts-tailwind-vite)
[](https://AR10Dev/tauri-solid-ts-tailwind-vite)
A starter template for [Tauri](https://tauri.app) + [Solid](https://solidjs.com) App that comes preconfigured with [Vite](https://vitejs.dev),
[TypeScript](https://typescriptlang.org), [Tailwind CSS](https://tailwindcss.com), [ESLint](https://eslint.org), [Prettier](https://prettier.io) and HMR.
## Features
- 🤩 [Tauri](https://tauri.app) - Build smaller, faster, and more secure desktop and mobile applications with a web frontend.
- ⚡️ [Solid](https://solidjs.com) & [Vite](https://vitejs.dev) - Simple and performant reactivity for building user interfaces.
- 🎨 [Tailwind CSS](https://tailwindcss.com) - A utility-first CSS framework for rapid UI development.
- 💪 [TypeScript](https://typescriptlang.org) - it's JavaScript with syntax for types.
- 👌 [ESLint](https://eslint.org) + [Prettier](https://prettier.io) - ESLint find problems in your code and Prettier format your code for an easy life.
## Getting started
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/AR10Dev/tauri-solid-ts-tailwind-vite/generate)
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx degit AR10Dev/tauri-solid-ts-tailwind-vite my-app # or bunx degit AR10Dev/tauri-solid-ts-tailwind-vite my-app
cd my-app
npm install # or pnpm install or yarn install or bun install
```
### Note
For use Tauri you need to Setup your environment following this [guide](https://tauri.app/guides/getting-started/prerequisites)
## Checklist
When you use this template, follow the checklist to update your info properly
- [ ] Rename `name`, `version` and `author` field in `package.json`
- [ ] Rename `name`, `version`, `description`, `authors` and `repository` field in `src-tauri/Cargo.toml`
- [ ] Change the author name in `LICENSE`
- [ ] Clean up the READMEs
- [ ] Optional: Remove the `.github` folder which contains the github action for cross compilation
- [ ] Enjoy 😉
## Usage
### Development
```bash
npm run dev:tauri # or pnpm dev:tauri or yarn dev:tauri or bun dev:tauri
```
Runs the app in the development mode.
The first time you run this command, it will take several minutes for the Rust package manager to download and build all the required packages. Since they are cached, subsequent builds will be much faster, as only your code will need rebuilding.
If you make edits to the page in the webview should update automatically just like a browser will reload.
When you make edits to the Rust files, they will be rebuilt automatically and your app will restart.
### Build
```bash
npm run build:tauri # or pnpm build:tauri or yarn build:tauri or bun build:tauri
```
Builds Solid to the `dist` folder and after will embed it into a single binary with your Rust code.
The binary itself will be located in `src-tauri/target/release/[app name]`, and installers will be located in `src-tauri/target/release/bundle/`
Like the `dev:tauri` command, the first time you run this, it will take some time to collect the Rust crates and build everything - but on subsequent runs it will only need to rebuild your code, which is much quicker.
It correctly bundles Solid in production mode and optimizes the binary for the best performance.
🎉 Congratulations, your app is ready to be release!
## Custom App Icon
To generate your custom app icon you can follow this [guide](https://tauri.app/guides/features/icons).
Your new app icons will be located in `src-tauri/icons/` and remeber to update the `icon` field in `src-tauri/tauri.conf.json` with all your new icon path name.
## Customize the tauri.conf.json
To modify and personalize your app, you need to modify `src-tauri/tauri.conf.json` by following this [guide](https://tauri.app/api/config)