go-pkg/wireguard-dashboard-admin
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

Merge branch 'main' of https://github.com/zclzone/vue-naive-admin

Browse Source
This commit is contained in:
张传龙 2023-03-08 11:01:00 +08:00
commit 0b50e1dbee
2 changed files with 83 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.zh-CN.md → README.EN.md
View File

@ -11,91 +11,87 @@
</p> </p>
<p align='center'> <p align='center'>
<b>简体中文</b> | <b>英文</b> |
<a href="https://github.com/zclzone/vue-naive-admin/blob/main/README.md">English</a> <a href="https://github.com/zclzone/vue-naive-admin/blob/main/README.md">中文</a>
</p> </p>
### 简介 ### Introduction
[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin) 是一个 **完全开源免费且允许商用** 的后台管理模板，基于 `Vue3、Vite3、Pinia、Unocss 和 Naive UI` 等前端最新技术栈。相较于其他比较流行的后台管理模板，此项目更加简洁、轻量，风格清新，学习成本非常低，非常适合中小型项目或者个人项目。 [Vue Naive Admin](https://github.com/zclzone/vue-naive-admin) is a **completely open source free and commercially allowed ** admin template，Based on the latest technology stack of front-end such as `Vue3、Vite3、Pinia、Unocss and Naive UI`. Compared with other more popular backend management templates, this project is more concise, lightweight, fresh style, very low learning costs, ideal for small and medium-sized projects or personal projects.
### 功能 ### Features
- 🍒 集成 [Naive UI](https://www.naiveui.com) - 🍒 Integrated [Naive UI](https://www.naiveui.com)，recommended by Evan You.
- 🍑 集成登陆、注销及权限验证 - 🍑 Integrated login, logout and permission verification.
- 🍐 集成多环境配置，dev、测试、生产和github pages环境 - 🍐 Integrated multi-environment configuration, dev, test, production and github pages environments.
- 🍎 集成 `eslint + prettier`，代码约束和格式化统一 - 🍎 Integrated `eslint + prettier`.
- 🍌 集成 `husky + commitlint`，代码提交规范化 - 🍌 Integrated `husky + commitlint`.
- 🍉 集成 `mock` 接口服务，dev 环境和发布环境都支持，可动态配置是否启用 mock 服务，不启用时不会加载 mock 包，减少打包体积 - 🍉 Integrated `Mock`.
- 🍍 集成 `pinia`，vuex 的替代方案，轻量、简单、易用 - 🍍 Integrated `pinia`，lightweight, simple and easy to use alternative to vuex.
- 📦 集成 `unplugin` 插件，自动导入，解放双手，开发效率直接起飞 - 📦 Integrated `unplugin` auto import.
- 🤹 集成 `iconify` 图标，支持自定义 svg 图标, 优雅使用icon - 🤹 Integrated `iconify` icon，support custom svg icons.
- 🍇 集成 `unocss`，antfu 开源的原子 css 解决方案，非常轻量 - 🍇 Integrated `unocss`.
### 预览 ### Preview
[https://template.qszone.com](https://template.qszone.com) [https://template.qszone.com](https://template.qszone.com)
[https://zclzone.github.io/vue-naive-admin](https://zclzone.github.io/vue-naive-admin) [https://zclzone.github.io/vue-naive-admin](https://zclzone.github.io/vue-naive-admin)
### 文档 ### Docs
[Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs) [Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs)
[羽雀文档：Vue Naive Admin](https://www.yuque.com/qszone/vue-naive-admin)
### 快速开始 ### Getting Started
```shell ```shell
# 推荐配置git autocrlf 为 false（本项目规范使用lf换行符，此配置是为防止git自动将源文件转换为crlf） # Recommended setup git autocrlf 为 false
# 不清楚为什么要这样做的请参考这篇文章：https://www.freesion.com/article/4532642129
git config --global core.autocrlf false git config --global core.autocrlf false
# 克隆项目 # Clone Project
git clone https://github.com/zclzone/vue-naive-admin.git git clone https://github.com/zclzone/vue-naive-admin.git
# 进入项目目录
cd vue-naive-admin cd vue-naive-admin
# 安装依赖(建议使用pnpm: https://pnpm.io/zh/installation) # Install dependencies(Recommended use pnpm: https://pnpm.io/zh/installation)
npm i -g pnpm # 装了可忽略 npm i -g pnpm # Installed and can be ignored
pnpm i # 或者 npm i pnpm i # or npm i
# 启动 # Start
pnpm dev pnpm dev
``` ```
### 构建发布 ### Build and Release
```shell ```shell
# 构建测试环境 # Test Environment
pnpm build:test pnpm build:test
# 构建github pages环境 # Github Environment
pnpm build:github pnpm build:github
# 构建生产环境 # Prod Environment
pnpm build pnpm build
``` ```
### 其他指令 ### Other
```shell ```shell
# eslint代码格式检查 # eslint check
pnpm lint pnpm lint
# 代码检查并修复 # eslint check and fix
pnpm lint:fix pnpm lint:fix
# 预览发布包效果（需先执行构建指令） # Preview（Need to build first）
pnpm preview pnpm preview
# 提交代码（husky+commitlint） # Commit（husky+commitlint）
pnpm cz pnpm cz
``` ```
### Directory description
### 目录说明
``` ```
Vue Naive Admin Vue Naive Admin
@ -186,22 +182,25 @@ Vue Naive Admin
|-- vite.config.js // vite配置 |-- vite.config.js // vite配置
``` ```
### TS 版本: Qs Admin ### TS version: Qs Admin
#### 源码 #### source code
- gitub: [https://github.com/zclzone/qs-admin](https://github.com/zclzone/qs-admin) - gitub: [https://github.com/zclzone/qs-admin](https://github.com/zclzone/qs-admin)
- gitee: [https://gitee.com/zclzone/qs-admin-ts](https://gitee.com/zclzone/qs-admin-ts) - gitee: [https://gitee.com/zclzone/qs-admin-ts](https://gitee.com/zclzone/qs-admin-ts)
#### 预览 #### preview
- [https://admin.qszone.com](https://admin.qszone.com) - [https://admin.qszone.com](https://admin.qszone.com)
- [https://zclzone.github.io/qs-admin](https://zclzone.github.io/qs-admin) - [https://zclzone.github.io/qs-admin](https://zclzone.github.io/qs-admin)
### 入群交流 & 关于作者 ### Communication group & About the author
<a href="https://blog.qszone.com/about/"> <a href="https://blog.qszone.com/about/">
<img src="https://assets.qszone.com/images/about.png" style="max-width: 400px" /> <img src="https://assets.qszone.com/images/about.png" style="max-width: 400px" />
</a> </a>

83
README.md
View File

@ -11,87 +11,91 @@
</p> </p>
<p align='center'> <p align='center'>
<b>English</b> | <b>中文</b> |
<a href="https://github.com/zclzone/vue-naive-admin/blob/main/README.zh-CN.md">简体中文</a> <a href="https://github.com/zclzone/vue-naive-admin/blob/main/README.EN.md">English</a>
</p> </p>
### Introduction ### 简介
[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin) is a **completely open source free and commercially allowed ** admin template，Based on the latest technology stack of front-end such as `Vue3、Vite3、Pinia、Unocss and Naive UI`. Compared with other more popular backend management templates, this project is more concise, lightweight, fresh style, very low learning costs, ideal for small and medium-sized projects or personal projects. [Vue Naive Admin](https://github.com/zclzone/vue-naive-admin) 是一个 **完全开源免费且允许商用** 的后台管理模板，基于 `Vue3、Vite3、Pinia、Unocss 和 Naive UI` 等前端最新技术栈。相较于其他比较流行的后台管理模板，此项目更加简洁、轻量，风格清新，学习成本非常低，非常适合中小型项目或者个人项目。
### Features ### 功能
- 🍒 Integrated [Naive UI](https://www.naiveui.com)，recommended by Evan You. - 🍒 集成 [Naive UI](https://www.naiveui.com)
- 🍑 Integrated login, logout and permission verification. - 🍑 集成登陆、注销及权限验证
- 🍐 Integrated multi-environment configuration, dev, test, production and github pages environments. - 🍐 集成多环境配置，dev、测试、生产和github pages环境
- 🍎 Integrated `eslint + prettier`. - 🍎 集成 `eslint + prettier`，代码约束和格式化统一
- 🍌 Integrated `husky + commitlint`. - 🍌 集成 `husky + commitlint`，代码提交规范化
- 🍉 Integrated `Mock`. - 🍉 集成 `mock` 接口服务，dev 环境和发布环境都支持，可动态配置是否启用 mock 服务，不启用时不会加载 mock 包，减少打包体积
- 🍍 Integrated `pinia`，lightweight, simple and easy to use alternative to vuex. - 🍍 集成 `pinia`，vuex 的替代方案，轻量、简单、易用
- 📦 Integrated `unplugin` auto import. - 📦 集成 `unplugin` 插件，自动导入，解放双手，开发效率直接起飞
- 🤹 Integrated `iconify` icon，support custom svg icons. - 🤹 集成 `iconify` 图标，支持自定义 svg 图标, 优雅使用icon
- 🍇 Integrated `unocss`. - 🍇 集成 `unocss`，antfu 开源的原子 css 解决方案，非常轻量
### Preview ### 预览
[https://template.qszone.com](https://template.qszone.com) [https://template.qszone.com](https://template.qszone.com)
[https://zclzone.github.io/vue-naive-admin](https://zclzone.github.io/vue-naive-admin) [https://zclzone.github.io/vue-naive-admin](https://zclzone.github.io/vue-naive-admin)
### Docs ### 文档
[Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs) [Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs)
[羽雀文档：Vue Naive Admin](https://www.yuque.com/qszone/vue-naive-admin)
### Getting Started ### 快速开始
```shell ```shell
# Recommended setup git autocrlf 为 false # 推荐配置git autocrlf 为 false（本项目规范使用lf换行符，此配置是为防止git自动将源文件转换为crlf）
# 不清楚为什么要这样做的请参考这篇文章：https://www.freesion.com/article/4532642129
git config --global core.autocrlf false git config --global core.autocrlf false
# Clone Project # 克隆项目
git clone https://github.com/zclzone/vue-naive-admin.git git clone https://github.com/zclzone/vue-naive-admin.git
# 进入项目目录
cd vue-naive-admin cd vue-naive-admin
# Install dependencies(Recommended use pnpm: https://pnpm.io/zh/installation) # 安装依赖(建议使用pnpm: https://pnpm.io/zh/installation)
npm i -g pnpm # Installed and can be ignored npm i -g pnpm # 装了可忽略
pnpm i # or npm i pnpm i # 或者 npm i
# Start # 启动
pnpm dev pnpm dev
``` ```
### Build and Release ### 构建发布
```shell ```shell
# Test Environment # 构建测试环境
pnpm build:test pnpm build:test
# Github Environment # 构建github pages环境
pnpm build:github pnpm build:github
# Prod Environment # 构建生产环境
pnpm build pnpm build
``` ```
### Other ### 其他指令
```shell ```shell
# eslint check # eslint代码格式检查
pnpm lint pnpm lint
# eslint check and fix # 代码检查并修复
pnpm lint:fix pnpm lint:fix
# Preview（Need to build first） # 预览发布包效果（需先执行构建指令）
pnpm preview pnpm preview
# Commit（husky+commitlint） # 提交代码（husky+commitlint）
pnpm cz pnpm cz
``` ```
### Directory description
### 目录说明
``` ```
Vue Naive Admin Vue Naive Admin
@ -182,25 +186,22 @@ Vue Naive Admin
|-- vite.config.js // vite配置 |-- vite.config.js // vite配置
``` ```
### TS version: Qs Admin ### TS 版本: Qs Admin
#### source code #### 源码
- gitub: [https://github.com/zclzone/qs-admin](https://github.com/zclzone/qs-admin) - gitub: [https://github.com/zclzone/qs-admin](https://github.com/zclzone/qs-admin)
- gitee: [https://gitee.com/zclzone/qs-admin-ts](https://gitee.com/zclzone/qs-admin-ts) - gitee: [https://gitee.com/zclzone/qs-admin-ts](https://gitee.com/zclzone/qs-admin-ts)
#### preview #### 预览
- [https://admin.qszone.com](https://admin.qszone.com) - [https://admin.qszone.com](https://admin.qszone.com)
- [https://zclzone.github.io/qs-admin](https://zclzone.github.io/qs-admin) - [https://zclzone.github.io/qs-admin](https://zclzone.github.io/qs-admin)
### Communication group & About the author ### 入群交流 & 关于作者
<a href="https://blog.qszone.com/about/"> <a href="https://blog.qszone.com/about/">
<img src="https://assets.qszone.com/images/about.png" style="max-width: 400px" /> <img src="https://assets.qszone.com/images/about.png" style="max-width: 400px" />
</a> </a>