thnmtrn / vite-starter

vite vue starter with windicss

Mocking up web app with Vitesse^(speed)
_{Now with Windi CSS! ⚡️}

Live Demo

Features

• ⚡️ Vue 3, Vite 2, pnpm, ESBuild - born with fastness

• 🗂 File based routing

• 📦 Components auto importing

• 📑 Layout system

• 📲 PWA

• 🎨 Windi CSS - on-demand Tailwind CSS with speed

• 😃 Use icons from any icon sets, with no compromise

• 🌍 I18n ready

• 🗒 Markdown Support

• 🔥 Use the new <script setup> style

• 🖨 Server-side generation (SSG) via vite-ssg

• 🦾 TypeScript, of course

• ☁️ Deploy on Netlify, zero-config

Pre-packed

UI Frameworks

• Windi CSS (On-demand TailwindCSS) - lighter and faster, with a bundle additional features!
  • Windi CSS Typography - similar to Tailwind CSS Typography but for Windi CSS

Icons

• Iconify - use icons from any icon sets 🔍Icônes
• vite-plugin-icons - icons as Vue components

Plugins

• Vue Router
  • vite-plugin-pages - file system based routing
  • vite-plugin-vue-layouts - layouts for pages
• vite-plugin-components - components auto import
• vite-plugin-pwa - PWA
• vite-plugin-windicss - WindiCSS support
• vite-plugin-md - Markdown as components / components in Markdown
  • markdown-it-prism - Prism for syntax highlighting
  • prism-theme-vars - customizable Prism.js theme using CSS variables
• Vue I18n - Internationalization
  • vite-plugin-vue-i18n - Vite plugin for Vue I18n
• VueUse - collection of useful composition APIs
• @vueuse/head - manipulate document head reactively

Coding Style

• Use Composition API with <script setup> SFC syntax
• ESLint with @antfu/eslint-config, single quotes, no semi.

Dev tools

• TypeScript
• pnpm - fast, disk space efficient package manager
• vite-ssg - Server-side generation
• Netlify - zero-config deployment
• VS Code Extensions
  • Vite - Fire up Vite server automatically
  • Volar - Vue 3 <script setup> IDE support
  • Iconify IntelliSense - Icon inline display and autocomplete
  • i18n Ally - All in one i18n support
  • Windi CSS Intellisense - IDE support for Windi CSS
  • ESLint

Variations

As this template is strongly opinionated, the following provides a curated list for community maintained variations with different preferences and feature sets. Check them out as well. PR to add yours are also welcome!

• vitesse-lite by @kn0wn
• vitesse-addons by @johncampionjr - additional options for integrations, including Prettier and Storybook
• vitesse-ssr-template by @frandiox - Vitesse with SSR
• vitesse-nuxt - Vitesse for Nuxt 2 (expiremental)

Try it now!

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

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

Checklist

When you use this template, try follow the checklist to update your info properly

• Rename name field in package.json
• Change the author name in LICENSE
• Change the title in App.vue
• Change the favicon in public
• Remove the .github folder which contains the funding info
• Clean up the READMEs and remove routes

And, enjoy :)

Usage

Development

Just run and visit http://localhost:3333

pnpm dev

Build

To build the App, run

pnpm build

And you will see the generated file in dist that ready to be served.

Deploy on Netlify

Go to Netlify and select your clone, OK along the way, and your App will be live in a minute.

Why

I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.

So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintains your own forks. (see community maintained variation forks)