init readme
This commit is contained in:
scout
parent
dc07b81438
commit
ae04964c9f
107
README.md
107
README.md
@ -6,9 +6,9 @@
|
|||||||
|
|
||||||
<h1 align="center">nuxt-vant-mobile</h1>
|
<h1 align="center">nuxt-vant-mobile</h1>
|
||||||
|
|
||||||
An mobile web apps template based on the Nuxt _⁴_ ecosystem.
|
一个基于 Nuxt _⁴_ 生态系统的移动端 Web 应用模板。
|
||||||
|
|
||||||
一个基于 Nuxt _⁴_ 生态系统的移动 web 应用模板，帮助你快速完成业务开发。
|
一个基于 Nuxt _⁴_ 生态系统的移动端 Web 应用模板，帮助你快速完成业务开发。
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="https://img.shields.io/github/license/easy-temps/nuxt-vant-mobile" alt="license" />
|
<img src="https://img.shields.io/github/license/easy-temps/nuxt-vant-mobile" alt="license" />
|
||||||
@ -20,117 +20,84 @@ An mobile web apps template based on the Nuxt _⁴_ ecosystem.
|
|||||||
|
|
||||||
[文档](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)
|
[文档](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>
|
🖥 <a href="https://nuxt-vant-mobile.netlify.app">在线预览</a>
|
||||||
|
|
||||||
[](https://app.netlify.com/sites/nuxt-vant-mobile/deploys)
|
[](https://app.netlify.com/sites/nuxt-vant-mobile/deploys)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Features
|
## 特性
|
||||||
|
|
||||||
- 💚 [Nuxt](https://nuxt.com/) - SSR, ESR, File-based routing, components auto importing, modules, etc
|
- 💚 [Nuxt](https://nuxt.com/) - SSR、ESR、基于文件的路由、组件自动导入、模块等
|
||||||
|
|
||||||
- ⚡️ Vite - Instant HMR
|
- ⚡️ Vite - 即时热更新
|
||||||
|
|
||||||
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - The instant on-demand atomic CSS engine
|
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - 即时按需原子化 CSS 引擎
|
||||||
|
|
||||||
- 😃 Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/unocss/unocss)
|
- 😃 使用纯 CSS 的任意图标集，由 [UnoCSS](https://github.com/unocss/unocss) 提供支持
|
||||||
|
|
||||||
- 🔥 The `<script setup>` syntax
|
- 🔥 `<script setup>` 语法
|
||||||
|
|
||||||
- 🌍 [I18n ready](./i18n/locales)
|
- 🌍 [国际化支持](./i18n/locales)
|
||||||
|
|
||||||
- 🍍 [State Management via Pinia](https://github.com/vuejs/pinia), see [./app/composables/counter.ts](./app/composables/counter.ts)
|
- 🍍 [使用 Pinia 进行状态管理](https://github.com/vuejs/pinia)，查看 [./app/composables/counter.ts](./app/composables/counter.ts)
|
||||||
|
|
||||||
- 📑 [Layout system](./app/layouts)
|
- 📑 [布局系统](./app/layouts)
|
||||||
|
|
||||||
- 📥 APIs auto importing - for Composition API and custom composables
|
- 📥 API 自动导入 - 用于 Composition API 和自定义组合式函数
|
||||||
|
|
||||||
- 🦾 TypeScript, of course
|
- 🦾 当然支持 TypeScript
|
||||||
|
|
||||||
- ☁️ Deploy on [Netlify](https://www.netlify.com), zero-config
|
- ☁️ 零配置部署在 [Netlify](https://www.netlify.com) 上
|
||||||
|
|
||||||
## Nuxt Modules
|
## Nuxt 模块
|
||||||
|
|
||||||
- [Vant](https://github.com/youzan/vant) - Vue UI library for mobile web apps
|
- [Vant](https://github.com/youzan/vant) - 移动端 Vue UI 库
|
||||||
- [Nuxt ESLint](https://github.com/nuxt/eslint) - collection of ESLint-related packages for Nuxt
|
- [Nuxt ESLint](https://github.com/nuxt/eslint) - Nuxt 的 ESLint 相关包集合
|
||||||
- [i18n](https://github.com/nuxt-modules/i18n) - i18n module for Nuxt
|
- [i18n](https://github.com/nuxt-modules/i18n) - Nuxt 的国际化模块
|
||||||
- [ColorMode](https://github.com/nuxt-modules/color-mode) - dark and Light mode with auto detection made easy with Nuxt
|
- [ColorMode](https://github.com/nuxt-modules/color-mode) - 支持自动检测的深色和浅色模式
|
||||||
- [UnoCSS](https://github.com/unocss/unocss) - the instant on-demand atomic CSS engine
|
- [UnoCSS](https://github.com/unocss/unocss) - 即时按需原子化 CSS 引擎
|
||||||
- [Pinia](https://github.com/vuejs/pinia) - intuitive, type safe, light and flexible Store for Vue
|
- [Pinia](https://github.com/vuejs/pinia) - 直观、类型安全、轻量且灵活的 Vue 状态管理
|
||||||
- [Pinia Persistedstate](https://github.com/prazdevs/pinia-plugin-persistedstate) - configurable persistence and rehydration of Pinia stores
|
- [Pinia Persistedstate](https://github.com/prazdevs/pinia-plugin-persistedstate) - 可配置的 Pinia 存储持久化和重新激活
|
||||||
- [DevTools](https://github.com/nuxt/devtools) - unleash Nuxt Developer Experience
|
- [DevTools](https://github.com/nuxt/devtools) - 释放 Nuxt 开发者体验
|
||||||
|
|
||||||
## IDE
|
## 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)
|
我们推荐使用 [VS Code](https://code.visualstudio.com/) 搭配 [Volar](https://github.com/johnsoncodehk/volar) 以获得最佳体验（如果你安装了 [Vetur](https://vuejs.github.io/vetur/)，建议禁用它）
|
||||||
|
|
||||||
## Try it now
|
## 立即尝试
|
||||||
|
|
||||||
### GitHub Template
|
### GitHub 模板
|
||||||
|
|
||||||
[Create a repo from this template on GitHub](https://github.com/easy-temps/nuxt-vant-mobile/generate)
|
[从 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
|
如果你更喜欢手动操作并保持更清晰的 git 历史
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx tiged easy-temps/nuxt-vant-mobile my-nuxt-app
|
npx tiged easy-temps/nuxt-vant-mobile my-nuxt-app
|
||||||
cd my-nuxt-app
|
cd my-nuxt-app
|
||||||
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
|
pnpm i # 如果你没有安装 pnpm，请运行：npm install -g pnpm
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## 使用方法
|
||||||
|
|
||||||
### Development
|
### 开发
|
||||||
|
|
||||||
Just run and visit <http://localhost:3000>
|
只需运行并访问 <http://localhost:3000>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Build
|
### 构建
|
||||||
|
|
||||||
To build the App, run
|
要构建应用，运行
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
And you will see the generated file in `.output` that ready to be served.
|
你将在 `.output` 目录中看到生成的可以部署的文件。
|
||||||
|
|
||||||
### 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>
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user