Skip to content

Commit 5ebdfd9

Browse files
committed
docs: update readme.md 📝
1 parent 6fbde22 commit 5ebdfd9

File tree

1 file changed

+80
-2
lines changed

1 file changed

+80
-2
lines changed

README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,81 @@
1-
# vue3-vant-mobile
1+
<p align="center">
2+
<img alt="logo" src="https://opens-1308879050.cos.ap-beijing.myqcloud.com/vvm/logo.png" width="120" height="120" style="margin-bottom: 10px;">
3+
</p>
24

3-
🔥🔥🔥 基于Vue3、TypeScript、Vite、Pinia、Vant3 构建的移动APP基础架子
5+
<h1 align="center">Vue3-Vant-Mobile</h1>
6+
7+
<p align="center">Mobile Template built on Vue3、Vant4、Vite2、Pinia2、TypeScript </p>
8+
9+
<p align="center">
10+
<img src="https://img.shields.io/github/license/CharleeWa/vue3-vant-mobile" alt="license" />
11+
<img src="https://img.shields.io/github/package-json/v/CharleeWa/vue3-vant-mobile" alt="version" />
12+
<img src="https://img.shields.io/github/repo-size/CharleeWa/vue3-vant-mobile" alt="repo-size" />
13+
<img src="https://img.shields.io/github/languages/top/CharleeWa/vue3-vant-mobile" alt="languages" />
14+
<img src="https://img.shields.io/github/issues-closed/CharleeWa/vue3-vant-mobile" alt="issues" />
15+
</p>
16+
17+
## Introduction
18+
19+
🔥🔥🔥 Vue3 Vant Mobile based on `Vue3`, `Vant4`, `Vite2`, `Pinia2`, `TypeScript`; 🚀🚀🚀 Integrate `Plop` to generate any type of code block, integrate `Dark Mode` (Dark) configuration, integrate `Mock` data, and other handy extensions. 💖💖💖 In short, clean, simple, easy to use, reference, can save you a week of development time, hope you like it.
20+
21+
22+
## Preparation
23+
24+
- [Vite](https://cn.vitejs.dev/) - Familiar with vite features
25+
- [Vue3](https://v3.vuejs.org/) - Familiar with Vue3 basic syntax
26+
- [Vant4](https://youzan.github.io/vant/v4/#/zh-CN) - Familiar with the basic use of `Vant4`
27+
- [Pinia](https://pinia.vuejs.org/) - Familiar with the basic use of `Pinia`
28+
- [TypeScript](https://www.typescriptlang.org/) - Familiar with the basic syntax of `TypeScript`
29+
- [Vue-Router](https://router.vuejs.org/) - Familiar with the basic use of `Vue-Router`
30+
31+
## Install and use
32+
33+
- Get the project code
34+
35+
```bash
36+
git clone https://github.com/CharleeWa/vue3-vant-mobile.git
37+
```
38+
39+
- Installation dependencies
40+
41+
```bash
42+
cd vue3-vant-mobile
43+
44+
# with yarn
45+
yarn install
46+
47+
```
48+
49+
- run
50+
51+
```bash
52+
yarn dev
53+
```
54+
55+
- build
56+
57+
```bash
58+
yarn build
59+
```
60+
61+
## Preview
62+
63+
You can scan the following QR code to access the demo:
64+
65+
<img src="https://opens-1308879050.cos.ap-beijing.myqcloud.com/vvm/preview-qrcode.png" width="220" height="220" >
66+
67+
## Browser Support
68+
69+
Support modern browsers and Chrome >= 51、iOS >= 10.0 (same as Vue 3)
70+
71+
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
72+
| :-: | :-: | :-: | :-: | :-: |
73+
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
74+
75+
## Maintainer
76+
77+
[@CharleeWa](https://github.com/CharleeWa)
78+
79+
## LICENSE
80+
81+
[MIT](https://en.wikipedia.org/wiki/MIT_License)

0 commit comments

Comments
 (0)