/vue3-pinia-typescript

Here is a Vue 3 & Pinia & Typescript boilerplate for beginners

Primary LanguageVue

Vue 3 + Typescript + Pinia Boilerplate

This template should help get you started developing with Vue 3 in Vite + typescript + pinia + fetch.

This boilerplate project, which is at a starter/intermediate level, aims to help you quickly kick off a new project whenever you need to use Vue3, TypeScript, Fetch and Pinia.

🌐 Demo

https://mustafacagri.github.io/vue3-pinia-typescript

📷 Screenshot

Screen Recording 2023-02-12 at 19 49 02

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

yarn

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Run Unit Tests with Vitest

yarn test:unit

Lint with ESLint

yarn lint