[go: up one dir, main page]

Skip to content
/ vue3-starter Public template

šŸ–– A Better Vue 3 Starter Templateļ¼Œgenerate by create-vue.

License

Notifications You must be signed in to change notification settings

xiaoluoboding/vue3-starter

Repository files navigation

Vue 3 Starter

šŸ–– A Better Vue 3 Starter Templateļ¼Œgenerate by vuejs/create-vue.

Preview

Features

  • šŸ’Ø windicss - Next generation utility-first CSS framework
  • šŸ¤¹ unplugin-icons - Use icons from any iconsets
  • šŸ pinia - The Vue Store that you will enjoy using
  • šŸŒ vue-i18n - Vue I18n is internationalization plugin for Vue.js
  • šŸ› ļø @vueuse/core - Collection of essential Vue Composition Utilities

Use the Template

GitHub Template

create a repo from this template on GitHub

Clone to local

$> 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 + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

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) 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 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.

Project Setup

pnpm install

Compile and Hot-Reload for Development

pnpm run dev

Type-Check, Compile and Minify for Production

pnpm run build

Run Unit Tests with Vitest

pnpm run test:unit

Lint with ESLint

pnpm run lint

Related Template

  • nuxt3-starter - šŸ’š A Better Nuxt 3 Starter Templateļ¼Œgenerate by nuxi.

License

MIT - @xiaoluoboding