Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/museloper/vue-3-note
Vue Tutorial By Options API
https://github.com/museloper/vue-3-note
options-api vue-pinia vue-router vue-typescript vue-vite vue3
Last synced: 4 days ago
JSON representation
Vue Tutorial By Options API
- Host: GitHub
- URL: https://github.com/museloper/vue-3-note
- Owner: museloper
- Created: 2024-02-14T04:37:55.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-22T02:14:33.000Z (10 months ago)
- Last Synced: 2024-11-06T10:08:13.510Z (about 2 months ago)
- Topics: options-api, vue-pinia, vue-router, vue-typescript, vue-vite, vue3
- Language: Vue
- Homepage: https://7j4zsq-5173.csb.app
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-3-note
This template should help get you started developing with Vue 3 in Vite.
## create vue
```sh
$ npm create vue
```
```sh
Vue.js - The Progressive JavaScript Framework
√ Project name: ... vue-3-note
√ Add TypeScript? ... Yes
√ Add JSX Support? ... No
√ Add Vue Router for Single Page Application development? ... Yes
√ Add Pinia for state management? ... Yes
√ Add Vitest for Unit Testing? ... Yes
√ Add an End-to-End Testing Solution? » No
√ Add ESLint for code quality? ... Yes
√ Add Prettier for code formatting? ... Yes
Scaffolding project in C:\Users\jisuzzxng\Desktop\vue-3-note...
Done. Now run:
cd vue-3-note
npm install
npm run format
npm run dev
```
## 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
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```