https://github.com/xiaoluoboding/vue3-starter
🖖 A Better Vue 3 Starter Template，generate by create-vue.
https://github.com/xiaoluoboding/vue3-starter
create-vue-app pinia starter starter-template vue-i18n vue3 vuejs windicss
Last synced: 7 months ago
JSON representation
🖖 A Better Vue 3 Starter Template，generate by create-vue.
- Host: GitHub
- URL: https://github.com/xiaoluoboding/vue3-starter
- Owner: xiaoluoboding
- License: mit
- Created: 2022-03-30T08:26:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T04:09:17.000Z (almost 2 years ago)
- Last Synced: 2025-03-01T20:45:04.743Z (7 months ago)
- Topics: create-vue-app, pinia, starter, starter-template, vue-i18n, vue3, vuejs, windicss
- Language: Vue
- Homepage: https://a-better-vue3-starter.vercel.app/
- Size: 102 KB
- Stars: 17
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Vue 3 Starter
> 🖖 A Better Vue 3 Starter Template，generate by [vuejs/create-vue](https://github.com/vuejs/create-vue).
## Preview
## Features
- 💨 [windicss](https://windicss.org/integrations/vite.html) - Next generation utility-first CSS framework
- 🤹 [unplugin-icons](https://github.com/antfu/unplugin-icons) - Use icons from any iconsets
- 🍍 [pinia](https://pinia.esm.dev/) - The Vue Store that you will enjoy using
- 🌍 [vue-i18n](https://vue-i18n.intlify.dev/installation.html) - Vue I18n is internationalization plugin for Vue.js
- 🛠️ [@vueuse/core](https://vueuse.org/) - Collection of essential Vue Composition Utilities
## Use the Template
### GitHub Template
[create a repo from this template on GitHub](https://github.com/xiaoluoboding/vue3-starter/generate)
### Clone to local
```bash
$> npx degit xiaoluoboding/vue3-starter my-vue3-app
$> Done. Now run:
$>
$> cd my-vue3-app
$> pnpm install
$> pnpm run lint
$> pnpm run dev
```
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.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=johnsoncodehk.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 run dev
```
### Type-Check, Compile and Minify for Production
```sh
pnpm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
pnpm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```sh
pnpm run lint
```
## Related Template
* [nuxt3-starter](https://github.com/xiaoluoboding/nuxt3-starter) - 💚 A Better Nuxt 3 Starter Template，generate by `nuxi`.
## License
[MIT](./LICENSE) - [@xiaoluoboding](https://github.com/xiaoluoboding)