This is a starter project that uses Vuetify as the UI framework. Please use scss version 1.32.12 due to a problem on the Vuetify side.
Vuetify3 version is here.
This template is for using Vue2 with TypeScript in Vite. Includes vue-router and Vuex.
In addition, ESLint, Stylelint, and Prettier are also included and are set to be executed automatically at runtime and commit. (Since these settings are set strictly, please relax yourself.)
Also, when the development server is executed, it is checked in real time by vite-plugin-checker.
Vitest is included in the program for testing.
With the standard support for Composition API in vue 2.7 from 0.5.0, the default format is composition api.
vue-property-decorator will continue to be available, but mixed use is not recommended. 1
Vue3 adds a mechanism called Teleport, which allows you to install vue components anywhere. This starter template is for vue2, but you can do the same with vue2-teleport.
If you want to include JSON-LD, enter as follows.
<template>
<div class="container">
... Some Content
<teleport to="head">
<component :is="'script'" type="application/ld+json" v-text="jsonLd" />
</teleport>
</div>
</template>
<script>
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const jsonLd = ref(
JSON.stringfy({
'@schema': 'https://json.schemastore.org/jsonld.json',
'@context': 'http://schema.org',
'@type': 'WebSite',
name: 'Vite Vue2 Vuetify TypeScript Startar',
url: 'https://github.com/logue/vite-vue2-vuetify-ts-starter',
description: 'Vite Vue2 Vuetify TypeScript Demo Page',
})
);
return {
jsonLd,
};
},
});
</script>JSON-LD is literally a script, so it can't be embedded directly, so it's a roundabout thing like this, but simple things like meta tags are reflected by simply inserting a tag.
⚠ Notice: <component :is="'script'" ... /> becomes <component :as="'script'" ... /> in Vue3.
If you want to use vue-i18n, please install vue-i18n-composable and call the instance with useI18n().
In addition, the conventional method using $t() written in non composition-api can be used as it is.
VSCode + Volar (and disable Vetur).
| Command | Description |
|---|---|
| dev | Start devserver. |
| clean | Clear devserver cache. |
| lint | Run ESLint and prettier. |
| lint:style | Run Stylelint. |
| lint:markup | Check vue markup. |
| test | Run vitest |
| coverage | Output Coverage Report. |
| build | Build for production. |
| build:analyze | Execute Bundle Analyzer |
| build:deploy | Build for production without checking. |
| build:clean | Clear production build files. |
| preview | Run the program generated by the production build. |
It also works when migrating from VueCLI.
However, when importing a stylesheet with @import, it cannot be specified from the library directory. Must be specified from ./node_modules/.
When adding or deleting files, an error may occur and even if the error is corrected, it may not be reflected in devserver. In that case, stop devserver and delete all the files in the node_modules/.vite directory. You can also run it with the clean command.
Due to yarn issues, it may not work properly if the path contains non-ASCII characters (such as 日本語 or 한국어, 中文 etc.).
From 0.7.4, the default project type is module. If you find a plugin that doesn't work, remove "type": "module" from package.json.
When you use this template, try follow the checklist to update your info properly
- Change the author name in
LICENSEandpackage.json - Change the favicon in
publicandsrc/assets - Remove the
.githubfolder which contains the funding info - Clean up the READMEs and remove routes
- vite-vue2-ts-starter
- laravel9-vite-vue2-starter - for Laravel + Breeze.
- vite-vue2-ts-ssr-starter - SSR (Server Side Rendering) Version.