https://github.com/wrathofrathma/vue-tailwind-template
https://github.com/wrathofrathma/vue-tailwind-template
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wrathofrathma/vue-tailwind-template
- Owner: wrathofrathma
- Created: 2022-04-01T19:05:09.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-02T07:36:02.000Z (about 3 years ago)
- Last Synced: 2024-12-27T19:29:29.014Z (6 months ago)
- Language: Vue
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
This template is built with the intention of having somewhat a somewhat sane, but full featured template for Vue 3, Typescript, and Tailwind.
I built everything on top of the default Vue 3 / Typescript template from Vite.
# Features
- [x] Vue 3
- [x] Vue Router
- [x] Pinia
- [x] Typescript
- [x] Vite
- [x] Tailwindcss
- [x] Postcss
- [x] @ alias to src/ directory
- [x] Prettier auto formatting on commit
- [x] Composition api
- [ ] Axios
- [ ] dev server proxy
# Vue 3 + Typescript + Vite
This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
## Recommended IDE Setup
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)
## Type Support For `.vue` Imports in TS
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).