vue3-vant-mobile

English / 简体中文

An mobile web apps template based on the Vue 3 ecosystem.

一个基于 Vue 3 生态系统的移动 web 应用模板，帮助你快速完成业务开发。

🌐预览 / 📖文档 / 🗨️交流 / 📝反馈

Features

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

• 🗂 File based routing

• 📦 Components auto importing

• 🍍 State Management via Pinia

• 📲 PWA

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

• 🌍 I18n ready

• 🔥 Use the new <script setup> syntax

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

• 💪 TypeScript, of course

• 💾 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
• 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
• Pinia - Intuitive, type safe, light and flexible Store for Vue using the composition api
  • pinia-plugin-persistedstate - Configurable persistence and rehydration of Pinia stores
• Vue I18n - Internationalization
  • unplugin-vue-i18n - unplugin for Vue I18n
• 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
• vueuse - collection of useful composition APIs
• @unhead/vue v2 - manipulate document head reactively
• vite-plugin-pwa - PWA
• vite-plugin-sitemap - sitemap and robots generator

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
• Netlify - zero-config deployment
• VS Code Extensions
  • Volar - Vue 3 <script setup> IDE support
  • Unocss - UnoCSS for VS Code
  • Goto Alias - Go to Definition following alias redirections
  • Iconify IntelliSense - Icon inline display and autocomplete
  • File Nesting - Config of File Nesting for VS Code
  • i18n Ally - All in one i18n support
  • ESLint - Eslint support
  • Better JSON5 - JSON5 support

Try it now

vue3-vant-mobile requires Node 20+

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 tiged vue-zone/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.

Community 👏

We recommend that issue be used for problem feedback, or Wechat group.

Donation ☕

Buy Me a Coffee

💝 Our Sponsors 💝

Your sponsorship will help us continue to iterate on this exciting project! 🚀

💪 Contributors 💪

Our contributors have made this project better. Thank you! 🙏

License

MIT License

⬆️ Back to Top