Vue3-Vant-Mobile

Live Demo

An mobile web apps template based on the Vue 3 ecosystem

English / 简体中文

Features

• ⚡️ Vue 3, Vite 5, pnpm, esbuild - born with fastness

• 🗂 File based routing

• 📦 Components auto importing

• 🍍 State Management via Pinia

• 📑 Layout system

• 📲 PWA

• 🎨 UnoCSS - the instant on-demand atomic CSS engine

• 🔥 Use the new <script setup> syntax

• 📥 APIs auto importing - use Composition API and others directly

• 💪 TypeScript, of course

• ⚙️ Unit Testing with Vitest

• 💾 Mock server Support

• 🌈 Git hooks - lint and commit

• 🪶 Vant - Vue UI library for mobile web apps

• 🔭 vConsole - the developer tool for mobile web page

• 📱 Browser adaptation - use viewport vw/vh units

• 💻 Desktop optimization - the mobile area

• 🌓 Dark Mode Support

• 🛡️ Configure ESM as default

• ☁️ Deploy on Netlify, zero-config

Pre-packed

UI Frameworks

• UnoCSS - The instant on-demand atomic CSS engine
  • @unocss/preset-rem-to-px - Converts rem to px for all utilities
  • eslint-plugin-unocss - ESLint plugin for UnoCSS
• Vant - Vue UI library for mobile web apps
  • vant-touch-emulator - Simulate mobile touch events on the desktop
  • vant-use - Built-in composition APIs of Vant

Plugins

• Vue Router
  • unplugin-vue-router - file system based routing
  • vite-plugin-vue-layouts - layouts for pages
• Pinia - Intuitive, type safe, light and flexible Store for Vue using the composition api
  • pinia-plugin-persistedstate - Configurable persistence and rehydration of Pinia stores
• unplugin-vue-components - components auto import
• unplugin-auto-import - Directly use Vue Composition API and others without importing
• vite-plugin-vconsole - A lightweight, extendable front-end developer tool for mobile web page
• vite-plugin-mock-dev-server - Vite Plugin for API mock dev server
• postcss-mobile-forever - To adapt different displays by one mobile viewport
• vite-plugin-vue-devtools - Designed to enhance the Vue developer experience
• vueuse - collection of useful composition APIs
• @unhead/vue - manipulate document head reactively
• vite-plugin-pwa - PWA

Coding Style

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

Dev tools

• TypeScript
• Vitest - Unit testing powered by Vite
• pnpm - fast, disk space efficient package manager
• 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
  • ESLint

Try it now

Vue3-Vant-Mobile requires Node 18+

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 CharleeWa/vue3-vant-mobile my-mobile-app
cd my-mobile-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

• Change the author name in LICENSE
• Change the title in index.html
• Change the hostname in vite.config.ts
• Change the favicon in public
• Clean up the READMEs and remove routes

And, enjoy :)

Usage

Development

Just run and visit http://localhost:3000

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.

Contributors

Charlie Wang	魏小雨	AlphaYoung	Leezon	liuNing	wswmsword
Kysen	阿峰	ReginYuan	Abraham K.

Star History