Lucas98Fernando / vue3-vite-ts-pinia-boilerplate

Boilerplate with Vue 3 + Vite + TypeScript + Pinia

Boilterplate Vue 3 + Typescript + Vite + Pinia

This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

🔨 Configured development tools:

• Vue 3
• Vite
• Typescript
• Vue Router
• Pinia
• Axios
• ESLint - Prettier

Unit tests tools

• Jest

Recommended IDE Setup

• VSCode + Volar

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's .vue type support plugin by running Volar: Switch TS Plugin on/off from VSCode command palette.

🚀 How to get started ?

1️⃣ Clone the repository

HTTPS

git clone https://github.com/Lucas98Fernando/vue3-vite-ts-pinia-boilerplate.git

SSH

git clone [e-mail]:Lucas98Fernando/vue3-vite-ts-pinia-boilerplate.git

2️⃣ Install dependencies

NPM

npm install

or only:

npm i

YARN

yarn install

or only:

yarn

3️⃣ Compilation and HMR for development with Vite

NPM

npm run dev

YARN

yarn dev

• Perfect! ✅ If you followed the previous steps correctly, the application will be running by default on: http://localhost:3000

4️⃣ Compile and minify for production

NPM

npm run build

YARN

yarn build

5️⃣ Lints and fix files

NPM

npm run lint

YARN

yarn lint