AntonyZ89/vue3-boilerplate

VueJS 3 Boilerplate ( Vanilla / Nuxt 3 )

VueJS Template 3

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + use TS Take Over mode.

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.

Global Components

Declare all global components on components.d.ts and Restart Vue Server ( CTRL + ⇧ Shift + P or ⌘ + ⇧ Shift + P )

Built with

• 
• 
  • Pinia
  • Vee-Validate + Yup
  • Vue-i18n
  • Vue-Router
• Eslint
• Prettier
• Vitest
• Husky
• Github Actions
  • Tests workflows

Prints 📷

Test coverage

unit coverage (93%!)

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 and Prettier

npm run lint
npm run prettier

Test

# unit tests
$ npm run test:watch

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Roadmap

• i18n
• router
• form validation
• pinia
• Unit tests
  • Coverage 100% (93%)
• husky
  • lint
  • unit test
• e2e tests
  • Coverage 100% (??%)
• Run tests on Pull Requests
• PR template
• Server-side rendering
  • SEO