feat: README头部徽标
This commit is contained in:
parent
9d29270cc5
commit
3ebedd9171
53
README.md
53
README.md
@ -1,11 +1,26 @@
|
|||||||
# SnowAdmin
|
# SnowAdmin
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://gitee.com/wang_fan_w/SnowAdmin" target="_blank">
|
||||||
|
<img src="https://img.shields.io/badge/License-MIT-%2343aefc" alt="License">
|
||||||
|
</a>
|
||||||
|
<a href="https://gitee.com/wang_fan_w/SnowAdmin" target="_blank">
|
||||||
|
<img src="https://img.shields.io/badge/vue_.js-vue3_.x-%2300b42a" alt="Vue">
|
||||||
|
</a>
|
||||||
|
<a href="https://gitee.com/wang_fan_w/SnowAdmin" target="_blank">
|
||||||
|
<img src="https://img.shields.io/badge/Vite-5x-%2300b42a" alt="Vite">
|
||||||
|
</a>
|
||||||
|
<a href="https://gitee.com/wang_fan_w/SnowAdmin" target="_blank">
|
||||||
|
<img src="https://img.shields.io/badge/Arco_Design-2.55.0-%2300b42a" alt="Arco-Design">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
### 介绍 📖
|
### 介绍 📖
|
||||||
|
|
||||||
SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板,基于最新的前端技术栈,包括 Vue3, Vite5, TypeScript, Pinia。它内置了丰富的主题配置和组件,代码规范严谨,实现了自动化的文件路由系统。SnowAdmin 为您提供了一站式的后台管理解决方案,无需额外配置,开箱即用。同样是一个快速学习前沿技术的最佳实践。
|
SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板,基于最新的前端技术栈,包括 Vue3, Vite5, TypeScript, Pinia。它内置了丰富的主题配置和组件,代码规范严谨,实现了自动化的文件路由系统。SnowAdmin 为您提供了一站式的后台管理解决方案,无需额外配置,开箱即用。同样是一个快速学习前沿技术的最佳实践。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 版本 📦
|
### 版本 📦
|
||||||
|
|
||||||
**预览及文档**
|
**预览及文档**
|
||||||
@ -21,8 +36,6 @@ SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板
|
|||||||
| GitHub | [Github 仓库](https://github.com/WANG-Fan0912/SnowAdmin) |
|
| GitHub | [Github 仓库](https://github.com/WANG-Fan0912/SnowAdmin) |
|
||||||
| Gitee | [Gitee 仓库](https://gitee.com/wang_fan_w/SnowAdmin) |
|
| Gitee | [Gitee 仓库](https://gitee.com/wang_fan_w/SnowAdmin) |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 先行预览
|
### 先行预览
|
||||||
|
|
||||||

|

|
||||||
@ -45,8 +58,6 @@ SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 项目功能 🔨
|
### 项目功能 🔨
|
||||||
|
|
||||||
- 清晰的项目架构:结构清晰,优雅易懂,代码全注释。
|
- 清晰的项目架构:结构清晰,优雅易懂,代码全注释。
|
||||||
@ -59,8 +70,6 @@ SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板
|
|||||||
- 使用 husky、lint-staged、commitlint等插件,规范提交信息
|
- 使用 husky、lint-staged、commitlint等插件,规范提交信息
|
||||||
- 丰富的页面组件:内置多样页面和组件,包括 401、404、500 页面,以及布局组件、标签组件、主题配置组件等。
|
- 丰富的页面组件:内置多样页面和组件,包括 401、404、500 页面,以及布局组件、标签组件、主题配置组件等。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 环境准备 🏝️
|
### 环境准备 🏝️
|
||||||
|
|
||||||
确保你的环境满足以下要求:
|
确保你的环境满足以下要求:
|
||||||
@ -69,8 +78,6 @@ SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板
|
|||||||
- **NodeJS**: >=18.12.0,推荐 20.12.0 或更高。
|
- **NodeJS**: >=18.12.0,推荐 20.12.0 或更高。
|
||||||
- **pnpm**: >= 8.7.0,推荐最新版本。
|
- **pnpm**: >= 8.7.0,推荐最新版本。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 安装使用步骤 📔
|
### 安装使用步骤 📔
|
||||||
|
|
||||||
### 从 GitHub 获取代码 🔗
|
### 从 GitHub 获取代码 🔗
|
||||||
@ -80,8 +87,6 @@ SnowAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板
|
|||||||
git clone https://github.com/WANG-Fan0912/SnowAdmin.git
|
git clone https://github.com/WANG-Fan0912/SnowAdmin.git
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 从 Gitee 获取代码 🔗
|
### 从 Gitee 获取代码 🔗
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -89,8 +94,6 @@ git clone https://github.com/WANG-Fan0912/SnowAdmin.git
|
|||||||
git clone https://gitee.com/wang_fan_w/SnowAdmin.git
|
git clone https://gitee.com/wang_fan_w/SnowAdmin.git
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 安装依赖 📌
|
### 安装依赖 📌
|
||||||
|
|
||||||
安装项目依赖
|
安装项目依赖
|
||||||
@ -99,16 +102,12 @@ git clone https://gitee.com/wang_fan_w/SnowAdmin.git
|
|||||||
pnpm install
|
pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 插件配置 🛠️
|
### 插件配置 🛠️
|
||||||
|
|
||||||
安装 Vue - Official,禁用 Vetur
|
安装 Vue - Official,禁用 Vetur
|
||||||
|
|
||||||
- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 服务插件
|
- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 服务插件
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 项目启动 🚀
|
### 项目启动 🚀
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -126,8 +125,6 @@ pnpm install
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 文件资源目录 📚
|
### 文件资源目录 📚
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@ -171,8 +168,6 @@ SnowAdmin
|
|||||||
└─ vite.config.ts # vite 全局配置文件
|
└─ vite.config.ts # vite 全局配置文件
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 浏览器支持 🌎
|
### 浏览器支持 🌎
|
||||||
|
|
||||||
- 本地开发推荐使用 Chrome 最新版浏览器 [Download](https://www.google.com/intl/zh-CN/chrome/)。
|
- 本地开发推荐使用 Chrome 最新版浏览器 [Download](https://www.google.com/intl/zh-CN/chrome/)。
|
||||||
@ -182,14 +177,10 @@ SnowAdmin
|
|||||||
| :---------------------------------------------: | :-----------------------------------------------: | :--------------------------------------------------: | :-------------------------------------------------: | :-------------------------------------------------: |
|
| :---------------------------------------------: | :-----------------------------------------------: | :--------------------------------------------------: | :-------------------------------------------------: | :-------------------------------------------------: |
|
||||||
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ### 项目后台接口 🧩
|
<!-- ### 项目后台接口 🧩
|
||||||
|
|
||||||
建设中 -->
|
建设中 -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 鸣谢列表 🧩
|
### 鸣谢列表 🧩
|
||||||
|
|
||||||
- [vue:https://v3.cn.vuejs.org/](https://v3.cn.vuejs.org/)
|
- [vue:https://v3.cn.vuejs.org/](https://v3.cn.vuejs.org/)
|
||||||
@ -215,14 +206,10 @@ SnowAdmin
|
|||||||
|
|
||||||
感谢以上框架为本项目提供了帮助,项目中的很多设计思想值得参考和学习,再次感谢。
|
感谢以上框架为本项目提供了帮助,项目中的很多设计思想值得参考和学习,再次感谢。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 支持作者 🌟
|
### 支持作者 🌟
|
||||||
|
|
||||||
如果觉得框架不错,或者已经在使用了,希望你可以去 [Github](https://github.com/WANG-Fan0912/SnowAdmin) 或者 [Gitee](https://gitee.com/wang_fan_w/SnowAdmin) 帮我点个 ⭐ Star,这将是对我极大的鼓励与支持。
|
如果觉得框架不错,或者已经在使用了,希望你可以去 [Github](https://github.com/WANG-Fan0912/SnowAdmin) 或者 [Gitee](https://gitee.com/wang_fan_w/SnowAdmin) 帮我点个 ⭐ Star,这将是对我极大的鼓励与支持。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 免责条款 📫
|
### 免责条款 📫
|
||||||
|
|
||||||
您充分了解并同意,您必须为自己使用本服务及注册帐号下的一切行为负责,包括您所发表的任何内容以及由此产生的任何后果。您应对本服务中的内容自行加以判断,并自行承担因使用内容而引起的所有风险。
|
您充分了解并同意,您必须为自己使用本服务及注册帐号下的一切行为负责,包括您所发表的任何内容以及由此产生的任何后果。您应对本服务中的内容自行加以判断,并自行承担因使用内容而引起的所有风险。
|
||||||
@ -233,16 +220,12 @@ SnowAdmin
|
|||||||
|
|
||||||
本声明未涉及的问题参见国家有关法律法规,当本声明与国家法律法规冲突时,以国家法律法规为准。
|
本声明未涉及的问题参见国家有关法律法规,当本声明与国家法律法规冲突时,以国家法律法规为准。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 学习 & 商用 🌈
|
### 学习 & 商用 🌈
|
||||||
|
|
||||||
`SnowAdmin` 是免费和开源的,可免费用于学习、商业使用 。
|
`SnowAdmin` 是免费和开源的,可免费用于学习、商业使用 。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 捐赠
|
### 捐赠
|
||||||
|
|
||||||
| 微信 | 支付宝 |
|
| 微信 | 支付宝 |
|
||||||
| :----------------------------------------------------------: | :----------------------------------------------------------: |
|
| :----------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
|
||||||
|  |  |
|
|  |  |
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user