Skip to content

Commit 39ac42f

Browse files
committed
chore: update readme
1 parent 5395617 commit 39ac42f

File tree

1 file changed

+126
-2
lines changed

1 file changed

+126
-2
lines changed

README.md

Lines changed: 126 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,127 @@
1-
# nuxt-vant-mobile
1+
<div align="center">
22

3-
> 🚧 正在积极开发中,欢迎 PR & Star
3+
<img src="https://cdn.jsdelivr.net/gh/easy-temps/easy-static/cover.png" alt="cover" />
4+
5+
<h1 align="center">nuxt④-vant-mobile</h1>
6+
7+
An mobile web apps template based on the Nuxt ecosystem.
8+
9+
一个基于 Nuxt __ 生态系统的移动 web 应用模板,帮助你快速完成业务开发。
10+
11+
<p>
12+
<img src="https://img.shields.io/github/license/easy-temps/nuxt-vant-mobile" alt="license" />
13+
<img src="https://img.shields.io/github/repo-size/easy-temps/nuxt-vant-mobile" alt="repo-size" />
14+
<img src="https://img.shields.io/github/issues-closed/easy-temps/nuxt-vant-mobile" alt="issues" />
15+
</p>
16+
17+
[文档](https://easy-temps.github.io/easy-docs/nuxt3-vant-mobile/) / [交流](https://github.com/easy-temps/vue3-vant-mobile/issues/56) / [反馈](https://github.com/easy-temps/nuxt-vant-mobile/issues)
18+
19+
<a href="https://nuxt-vant-mobile.netlify.app">Live Demo</a>
20+
21+
[![Netlify Status](https://api.netlify.com/api/v1/badges/1eb0d3f7-69a1-4972-a2b7-9e317ffa5c63/deploy-status)](https://app.netlify.com/sites/nuxt-vant-mobile/deploys)
22+
23+
</div>
24+
25+
## Features
26+
27+
- 💚 [Nuxt](https://nuxt.com/) - SSR, ESR, File-based routing, components auto importing, modules, etc
28+
29+
- ⚡️ Vite - Instant HMR
30+
31+
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - The instant on-demand atomic CSS engine
32+
33+
- 😃 Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/unocss/unocss)
34+
35+
- 🔥 The `<script setup>` syntax
36+
37+
- 🌍 [I18n ready](./i18n/locales)
38+
39+
- 🍍 [State Management via Pinia](https://github.com/vuejs/pinia), see [./app/composables/counter.ts](./app/composables/counter.ts)
40+
41+
- 📑 [Layout system](./app/layouts)
42+
43+
- 📥 APIs auto importing - for Composition API and custom composables
44+
45+
- 🦾 TypeScript, of course
46+
47+
- ☁️ Deploy on [Netlify](https://www.netlify.com), zero-config
48+
49+
## Nuxt Modules
50+
51+
- [Vant](https://github.com/youzan/vant) - Vue UI library for mobile web apps
52+
- [Nuxt ESLint](https://github.com/nuxt/eslint) - collection of ESLint-related packages for Nuxt
53+
- [i18n](https://github.com/nuxt-modules/i18n) - i18n module for Nuxt
54+
- [ColorMode](https://github.com/nuxt-modules/color-mode) - dark and Light mode with auto detection made easy with Nuxt
55+
- [UnoCSS](https://github.com/unocss/unocss) - the instant on-demand atomic CSS engine
56+
- [Pinia](https://github.com/vuejs/pinia) - intuitive, type safe, light and flexible Store for Vue
57+
- [Pinia Persistedstate](https://github.com/prazdevs/pinia-plugin-persistedstate) - configurable persistence and rehydration of Pinia stores
58+
- [DevTools](https://github.com/nuxt/devtools) - unleash Nuxt Developer Experience
59+
60+
## IDE
61+
62+
We recommend using [VS Code](https://code.visualstudio.com/) with [Volar](https://github.com/johnsoncodehk/volar) to get the best experience (You might want to disable [Vetur](https://vuejs.github.io/vetur/) if you have it)
63+
64+
## Try it now
65+
66+
### GitHub Template
67+
68+
[Create a repo from this template on GitHub](https://github.com/easy-temps/nuxt-vant-mobile/generate)
69+
70+
### Clone to local
71+
72+
If you prefer to do it manually with the cleaner git history
73+
74+
```bash
75+
npx tiged easy-temps/nuxt-vant-mobile my-nuxt-app
76+
cd my-nuxt-app
77+
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
78+
```
79+
80+
## Usage
81+
82+
### Development
83+
84+
Just run and visit <http://localhost:3000>
85+
86+
```bash
87+
pnpm dev
88+
```
89+
90+
### Build
91+
92+
To build the App, run
93+
94+
```bash
95+
pnpm build
96+
```
97+
98+
And you will see the generated file in `.output/public` that ready to be served.
99+
100+
### Deploy on Netlify
101+
102+
Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.
103+
104+
## Community 👏
105+
106+
We recommend that [issue](https://github.com/easy-temps/nuxt-vant-mobile/issues) be used for problem feedback, or [Wechat group](https://github.com/easy-temps/vue3-vant-mobile/issues/56).
107+
108+
## Donation ☕
109+
110+
[Buy Me a Coffee](https://github.com/CharleeWa/sponsor)
111+
112+
<h2 align="center">💝 Our Sponsors 💝</h2>
113+
114+
<p align="center">
115+
Your sponsorship will help us continue to iterate on this exciting project! 🚀
116+
</p>
117+
118+
<p align="center">
119+
<a href="https://github.com/keyFeng"><img src="https://avatars.githubusercontent.com/u/52267976?v=4" width="60px" alt="keyFeng" /></a>
120+
<a href="https://github.com/ljt990218"><img src="https://avatars.githubusercontent.com/u/50509815?v=4" width="60px" alt="ljt990218" /></a>
121+
<a href="https://github.com/heked"><img src="https://avatars.githubusercontent.com/u/14127731?v=4" width="60px" alt="heked" /></a>
122+
<a href="https://github.com/topcnm"><img src="https://avatars.githubusercontent.com/u/8057893?v=4" width="60px" alt="topcnm" /></a>
123+
</p>
124+
125+
## License
126+
127+
[MIT](./LICENSE) License

0 commit comments

Comments
 (0)