vue-3-stackter

A Vue3 starter project setup with TypeScript and,

• Vite
• vue-meta-3.0.0-alpha.8
• Router
• Vuex
• Eslint
• Prettier
• Tailwind CSS
• and some custom preferences.

Check out Javascript version here

Run this project:

yarn
yarn dev

Change site name

In App.vue change the following,

const siteName = 'Vite App' // add your site name here

Layouts

You can add layouts in your project if you want. You will find a default.vue layout example in this project.

Pages

You can add pages to your project. You will find two example pages in the pages directory (Home.vue and About.vue). Do not forget to register the pages in the router. You will also find a router/index.ts file to register your pages.

Meta info

You can add meta information in your pages. Here is an example,

<script setup>
import { useMeta } from 'vue-meta'

useMeta({
    title: 'Homepage',
})
...

</script>

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

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 use the following:

If Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

If Using Vetur

1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
3. Open src/main.ts in VSCode
4. Open the VSCode command palette
5. Search and run "Select TypeScript version" -> "Use workspace version"