Skip to content

Vue3 template with TypeScript, Pinia, router, i18n, Bootstrap, Font Awesome and validation

License

Notifications You must be signed in to change notification settings

Logitar/Vue3Template

Repository files navigation

Logitar Vue3 Template

This template should help get you started developing with Vue 3 in Vite. It integrates TypeScript, Pinia stores, routing, i18n, Bootstrap, Font Awesome, forms and validation, and unit tests using Vitest.

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

Preview the Last Build from dist

npm run preview

Run Unit Tests and Code Coverage with Vitest

npm run test

Run Unit Tests with Vitest

npm run test:dev

Build the Application Without Type Checking for Production

npm run build-only

Type Check the Application Code Without Building

npm run type-check

Lint with ESLint

npm run lint

Format with Prettier

npm run format