uvacoder / vitesome-starter-2

_{Logo created with Windcss logo + Icons made by Vectors Market & Pixel perfect from www.flaticon.com}

Vitesome 🌬 ⛵️

A simple opinionated Vue Starter Template with Vite.js

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

Features

• Vite ⚡️, Vue,
• 💨 UnoCSS
• 📦 Components auto importing
• i18n out of the box 👩‍🎨
• Pure CSS Icons - use any icon as a single class or attribute 🔝
• Routing with Vue Router 4
• Deploy on Netlify

Live Demo

You can help me keep working on this project 💚

• Become a Sponsor on GitHub
• One-time donation via PayPal

Generous Unicorns 🦄

Pre-📦

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

Styling

• UnoCSS with The instant on-demand Atomic CSS engine.

Icons

• Iconify - use icons from any icon sets 🔍Icônes
• Pure CSS Icons with @unocss/preset-icons

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
• pnpm - fast, disk space efficient package manager
• Iconify IntelliSense - Icon inline display and autocomplete

Check it out

You can create a repo with this template here

Or if you prefer to do it manually with the cleaner git history

npx degit alvarosabu/vitesome my-vitesome-app
cd my-vitesome-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

Project setup

pnpm i

Use it

pnpm run dev

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

Build it

pnpm run 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!

See the section about deployment for more information.

Deployment

Visit Netlify and select your repo, select OK along the way, and your App will be live in a minute.

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"