Vue3 Starter

A boilerplate for Vue3 + TS + Vite SPAs.

Features

• Vue3 + Vite + TypeScript
• Vue Router
• VueUse
• TailwindCSS v3 w/ Tailwind Config Viewer
• Form Validation w/ Vuelidate
• Icons w/ Iconify
• Hooks w/ Husky
• ESLint + Prettier
• Group by Feature folder structure
• Localization w/ Fluent

Examples Included

• Login Form
• Simple Base Components
• Composables
• Layouts
• Theme Switcher
• Router Nav Guard
• Environment Variables
• Language Switcher

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

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

View Tailwind Config

npm run tailwind-config-viewer

Contributing

If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome but do consider the opinionated nature of this project. Please open an issue before submitting a pull request.