BigScreenUI/README.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

2023-11-30 13:40:30 +08:00
# vue3PcTemplate
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
This template should help get you started developing with Vue 3 in Vite.
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
## Recommended IDE Setup
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
[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).
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
## Type Support for `.vue` Imports in TS
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
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.
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
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:
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
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.
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
## Customize configuration
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
See [Vite Configuration Reference](https://vitejs.dev/config/).
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
## Project Setup
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
```sh
npm install
2023-11-30 10:48:06 +08:00
```
2023-11-30 13:40:30 +08:00
### Compile and Hot-Reload for Development
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
```sh
npm run dev
2023-11-30 10:48:06 +08:00
```
2023-11-30 13:40:30 +08:00
### Type-Check, Compile and Minify for Production
2023-11-30 10:48:06 +08:00
2023-11-30 13:40:30 +08:00
```sh
npm run build
2023-11-30 10:48:06 +08:00
```