Overview
This product is called Vue3-Vant-Mobile and it is a web application template built with Vue 3, Vite 5, and Vant. It has a focus on fast performance and offers features such as file-based routing, components auto-importing, state management via Pinia, and support for TypeScript. It also includes a UI framework called UnoCSS and offers support for dark mode and mobile browser adaptation. The template can be easily installed and deployed on platforms like Netlify.
Features
- Vue 3, Vite 5, pnpm, esbuild - Built with fastness
- File based routing - Easy navigation through file structure
- Components auto importing - Simplifies the use of components
- State Management via Pinia - Intuitive, type safe, light, and flexible store for Vue
- UnoCSS - The instant on-demand atomic CSS engine
- Use the new
<script setup>
syntax - Leveraging the latest features of Vue - APIs auto importing - Directly use Composition API and others without importing
- TypeScript - Supports TypeScript for type-safe development
- Unit Testing with Vitest - Unit testing powered by Vite
- Mock server support - Support for API mock dev server
- Git hooks - Lint and commit hooks for code quality
- Vant - Vue UI library for mobile web apps
- vConsole - Developer tool for mobile web pages
- Browser adaptation - Use viewport vw/vh units for mobile web adaptation
- Desktop optimization - Optimized for desktop experience in mobile area
- Dark Mode Support - Configurable dark mode support
- Configure ESM as default - ESM configuration as default
- Deploy on Netlify - Zero-config deployment on Netlify
Installation
To install and use Vue3-Vant-Mobile, follow these steps:
- Clone the repository to your local machine.
- Update the necessary information:
- Change the author name in the LICENSE file.
- Change the title in the index.html file.
- Change the hostname in the vite.config.ts file.
- Change the favicon in the public folder.
- Clean up the READMEs and remove unnecessary routes.
- Install the dependencies by running
pnpm install
. - Start the development server by running
pnpm dev
. - Visit
http://localhost:3000
in your browser to view the app.
To build the app for production, run pnpm build
. You will find the generated files in the dist
folder ready to be served.
To deploy the app on Netlify, follow these steps:
- Go to the Netlify website and select your cloned repository.
- Follow the instructions and configuration steps to deploy the app on Netlify.
- Your app will be live in a minute.
Summary
Vue3-Vant-Mobile is a web application template built with Vue 3 and Vite 5. It offers a range of features including file-based routing, components auto-importing, state management via Pinia, and support for TypeScript. The template also includes a UI framework called UnoCSS and provides support for dark mode and mobile browser adaptation. It can be easily installed and deployed on platforms like Netlify.