A simple opinionated Vue3 Starter Template with Vite.js

Vitesome

A simple opinionated Vue3 Starter Template with Vite.js.

This template should help get you started developing with Vue 3 and Typescript in Vite in a bliss.

Features

• Vite ⚡️, Vue 3,
• ? Windi CSS
• ? Components auto importing
• i18n out of the box ?‍?
• Easy to use svg icons based on Iconify ?
• Routing with Vue Router 4
• Deploy on Netlify

Pre-?

This repo brings few things pre-packed, so you don't need to install them manually everytime.

Styling

• Windi CSS with vite-plugin-windicss
• Default Google Fonts with vite-plugin-fonts

Icons

• Iconify - use icons from any icon sets ?Icônes
  • PurgeIcons with `vite-plugin-purge-icons Think about TailwindCSS + PurgeCSS, but for Icons.
  • Custom icons below ./assets/icons with

Plugins

• VueUse - collection of useful composition APIs
• Vue I18n - Internationalization
• Component auto-import with vite-plugin-components

Dev tools

• i18n Ally - All in one i18n support
• Windi CSS Intellisense - IDE support for Windi CSS
• Iconify IntelliSense - Icon inline display and autocomplete

Project setup

yarn

Use it

yarn dev

This will serve the app at http://localhost:3260

Build it

yarn build

Builds the app for production to the dist folder.

It correctly bundles Vue in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

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 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"