Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liuw5367/vue-starter
vue-starter
https://github.com/liuw5367/vue-starter
jsx pinia ts tsx typescript unocss unplugin vue vue3
Last synced: 26 days ago
JSON representation
vue-starter
- Host: GitHub
- URL: https://github.com/liuw5367/vue-starter
- Owner: liuw5367
- License: mit
- Created: 2024-01-03T01:48:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-16T01:59:51.000Z (10 months ago)
- Last Synced: 2024-10-12T08:43:20.475Z (3 months ago)
- Topics: jsx, pinia, ts, tsx, typescript, unocss, unplugin, vue, vue3
- Language: TypeScript
- Homepage: https://liuw5367.github.io/vue-starter
- Size: 569 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-starter
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
pnpm install
```
### Compile and Hot-Reload for Development
```sh
pnpm dev
```
### Type-Check, Compile and Minify for Production
```sh
pnpm build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
pnpm test
```
### Lint with [ESLint](https://eslint.org/)
```sh
pnpm lint
```