liveh5-nuxt/README.md

137 lines
5.0 KiB
Markdown
Raw Normal View History

2025-01-08 05:26:12 +00:00
<!-- markdownlint-disable MD033 MD041 -->
<div id="top" align="center">
<img src="https://cdn.jsdelivr.net/gh/easy-temps/easy-static/cover.png" alt="cover" />
<h1 align="center">nuxt-vant-mobile</h1>
An mobile web apps template based on the Nuxt _⁴_ ecosystem.
一个基于 Nuxt _⁴_ 生态系统的移动 web 应用模板,帮助你快速完成业务开发。
<p>
<img src="https://img.shields.io/github/license/easy-temps/nuxt-vant-mobile" alt="license" />
<img src="https://img.shields.io/github/package-json/v/easy-temps/nuxt-vant-mobile" alt="version" />
<img src="https://img.shields.io/github/repo-size/easy-temps/nuxt-vant-mobile" alt="repo-size" />
<img src="https://img.shields.io/github/languages/top/easy-temps/nuxt-vant-mobile" alt="languages" />
<img src="https://img.shields.io/github/issues-closed/easy-temps/nuxt-vant-mobile" alt="issues" />
</p>
[文档](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)
🖥 <a href="https://nuxt-vant-mobile.netlify.app">Online Preview</a>
[![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)
</div>
## Features
- 💚 [Nuxt](https://nuxt.com/) - SSR, ESR, File-based routing, components auto importing, modules, etc
- ⚡️ Vite - Instant HMR
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - The instant on-demand atomic CSS engine
- 😃 Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/unocss/unocss)
- 🔥 The `<script setup>` syntax
- 🌍 [I18n ready](./i18n/locales)
- 🍍 [State Management via Pinia](https://github.com/vuejs/pinia), see [./app/composables/counter.ts](./app/composables/counter.ts)
- 📑 [Layout system](./app/layouts)
- 📥 APIs auto importing - for Composition API and custom composables
- 🦾 TypeScript, of course
- ☁️ Deploy on [Netlify](https://www.netlify.com), zero-config
## Nuxt Modules
- [Vant](https://github.com/youzan/vant) - Vue UI library for mobile web apps
- [Nuxt ESLint](https://github.com/nuxt/eslint) - collection of ESLint-related packages for Nuxt
- [i18n](https://github.com/nuxt-modules/i18n) - i18n module for Nuxt
- [ColorMode](https://github.com/nuxt-modules/color-mode) - dark and Light mode with auto detection made easy with Nuxt
- [UnoCSS](https://github.com/unocss/unocss) - the instant on-demand atomic CSS engine
- [Pinia](https://github.com/vuejs/pinia) - intuitive, type safe, light and flexible Store for Vue
- [Pinia Persistedstate](https://github.com/prazdevs/pinia-plugin-persistedstate) - configurable persistence and rehydration of Pinia stores
- [DevTools](https://github.com/nuxt/devtools) - unleash Nuxt Developer Experience
## IDE
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)
## Try it now
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/easy-temps/nuxt-vant-mobile/generate)
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx tiged easy-temps/nuxt-vant-mobile my-nuxt-app
cd my-nuxt-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
## Usage
### Development
Just run and visit <http://localhost:3000>
```bash
pnpm dev
```
### Build
To build the App, run
```bash
pnpm build
```
And you will see the generated file in `.output` that ready to be served.
### Deploy on Netlify
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.
## Community 👏
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).
## Donation ☕
[Buy Me a Coffee](https://github.com/CharleeWa/sponsor)
<h2 align="center">💝 Our Sponsors 💝</h2>
<p align="center">
Your sponsorship will help us continue to iterate on this exciting project! 🚀
</p>
<p align="center">
<a href="https://github.com/keyFeng"><img src="https://avatars.githubusercontent.com/u/52267976?v=4" width="60px" alt="keyFeng" /></a>
<a href="https://github.com/ljt990218"><img src="https://avatars.githubusercontent.com/u/50509815?v=4" width="60px" alt="ljt990218" /></a>
<a href="https://github.com/heked"><img src="https://avatars.githubusercontent.com/u/14127731?v=4" width="60px" alt="heked" /></a>
<a href="https://github.com/topcnm"><img src="https://avatars.githubusercontent.com/u/8057893?v=4" width="60px" alt="topcnm" /></a>
<a href="https://github.com/qiyue2015"><img src="https://avatars.githubusercontent.com/u/11554433?v=4" width="60px" alt="qiyue2015" /></a>
</p>
## License
[MIT](./LICENSE) License
<p align="right">
<a href="#top">⬆️ Back to Top</a>
</p>