docs: update
This commit is contained in:
pany
parent
deb2d3da13
commit
358f086f07
141
README.md
141
README.md
@ -1,127 +1,122 @@
|
||||
## ⚡️ 简介
|
||||
## ⚡ Introduction
|
||||
|
||||
<p align="center">
|
||||
<span>中文 | <a href="./README_en.md">English</a></span>
|
||||
<span>English | <a href="./README.zh-CN.md">中文</a></span>
|
||||
</p>
|
||||
|
||||
一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite 等主流技术.
|
||||
v3-admin-vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element-Plus, Pinia and Vite.
|
||||
|
||||
模板代码是从 [v3-admin](https://github.com/un-pany/v3-admin) 迁移而来，脚手架从 Vue-Cli 5.x 切换到了 Vite 3.x，并作了一些繁琐的适配.
|
||||
- Vue-Cli 5.x: [v3-admin](https://github.com/un-pany/v3-admin)
|
||||
- Electron desktop: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
|
||||
|
||||
更推荐大家使用该 Vite 版本！以后的重心也会从 [v3-admin](https://github.com/un-pany/v3-admin) 偏向本仓库.
|
||||
## Feature
|
||||
|
||||
- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
|
||||
- **Vue3**：The latest Vue3 composition API using Vue3 + script setup
|
||||
- **Element Plus**：Vue3 version of Element UI
|
||||
- **Pinia**: An alternative to Vuex in Vue3
|
||||
- **Vite**：Really fast
|
||||
- **Vue Router**：router
|
||||
- **TypeScript**：JavaScript With Syntax For Types
|
||||
- **PNPM**：Faster, disk space saving package management tool
|
||||
- **Scss**：Consistent with Element Plus
|
||||
- **CSS variable**：Mainly controls the layout and color of the item
|
||||
- **ESlint**：Code verification
|
||||
- **Prettier**： Code formatting
|
||||
- **Axios**: Promise based HTTP client（encapsulated）
|
||||
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
|
||||
- **Annotation**：Each configuration item is written with as detailed comments as possible
|
||||
- **Mobile Compatible**: The layout is compatible with mobile page resolution
|
||||
|
||||
## 特性
|
||||
## Functions
|
||||
|
||||
- **Vue3**：采用 Vue3 + script setup 最新的 Vue3 组合式 API
|
||||
- **Element Plus**：Element UI 的 Vue3 版本
|
||||
- **Pinia**: 传说中的 Vuex5
|
||||
- **Vite**：真的很快
|
||||
- **Vue Router**：路由路由
|
||||
- **TypeScript**：JavaScript 语言的超集
|
||||
- **PNPM**：更快速的，节省磁盘空间的包管理工具
|
||||
- **Scss**：和 Element Plus 保持一致
|
||||
- **CSS 变量**：主要控制项目的布局和颜色
|
||||
- **ESlint**：代码校验
|
||||
- **Prettier**：代码格式化
|
||||
- **Axios**：发送网络请求（已封装好）
|
||||
- **UnoCSS**：具有高性能且极具灵活性的即时原子化 CSS 引擎
|
||||
- **注释**：各个配置项都写有尽可能详细的注释
|
||||
- **User management**: log in, log out of the demo
|
||||
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
|
||||
- **Multiple Environments**: Development、staging、production
|
||||
- **Multiple themes**: normal and dark theme modes
|
||||
- **Error page**: 403、404
|
||||
- **Dashboard**: Display different Dashboard pages according to different users
|
||||
- **Other functions**：SVG、Dynamic Sidebar、Dynamic Breadcrumb Navigation、Tabbed Navigation、Screenfull、Adaptive Shrink Sidebar
|
||||
|
||||
## 功能
|
||||
## 📚 Document
|
||||
|
||||
- **用户管理**：登录、登出演示
|
||||
- **权限管理**：内置页面权限（动态路由）、指令权限、权限函数、路由守卫
|
||||
- **多环境**：开发环境（development）、预发布环境（staging）、正式环境（production）
|
||||
- **多主题**：内置普通、黑暗两种主题模式
|
||||
- **错误页面**: 403、404
|
||||
- **Dashboard**：根据不同用户显示不同的 Dashboard 页面
|
||||
- **其他内置功能**：SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏（兼容移动端）
|
||||
[Chinese documentation](https://juejin.cn/post/7089377403717287972)
|
||||
|
||||
## 📚 文档
|
||||
|
||||
[简体中文](https://juejin.cn/post/7089377403717287972)
|
||||
|
||||
## 国内仓库
|
||||
## Gitee repository
|
||||
|
||||
[Gitee](https://gitee.com/un-pany/v3-admin-vite)
|
||||
|
||||
## 预览
|
||||
## Online preview
|
||||
|
||||
| 位置 | 账号 | 链接 |
|
||||
| ------------ | --------------- | ----------------------------------------------- |
|
||||
| github-pages | admin 或 editor | [链接](https://un-pany.github.io/v3-admin-vite) |
|
||||
| Location | account | Link |
|
||||
| ------------ | ------------------- | ----------------------------------------------- |
|
||||
| github-pages | `admin` or `editor` | [Link](https://un-pany.github.io/v3-admin-vite) |
|
||||
|
||||
## 🚀 开发
|
||||
## 🚀 Development
|
||||
|
||||
```bash
|
||||
# 配置
|
||||
1. 一键安装 .vscode 目录中推荐的插件
|
||||
3. node 版本 16+
|
||||
4. pnpm 版本 7.x
|
||||
# configure
|
||||
1. installation of the recommended plugins in the .vscode directory
|
||||
3. node version 16+
|
||||
4. pnpm version 7.x
|
||||
|
||||
# 克隆项目
|
||||
# clone
|
||||
git clone https://github.com/un-pany/v3-admin-vite.git
|
||||
|
||||
# 进入项目目录
|
||||
# enter the project directory
|
||||
cd v3-admin-vite
|
||||
|
||||
# 安装依赖
|
||||
# install dependencies
|
||||
pnpm i
|
||||
|
||||
# 初始化 husky
|
||||
pnpm prepare
|
||||
|
||||
# 启动服务
|
||||
# start the service
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## ✔️ 预览
|
||||
## ✔️ Preview
|
||||
|
||||
```bash
|
||||
# 预览预发布环境
|
||||
# stage environment
|
||||
pnpm preview:stage
|
||||
|
||||
# 预览正式环境
|
||||
# prod environment
|
||||
pnpm preview:prod
|
||||
```
|
||||
|
||||
## 📦️ 多环境打包
|
||||
## 📦️ Multi-environment packaging
|
||||
|
||||
```bash
|
||||
# 构建预发布环境
|
||||
# build the stage environment
|
||||
pnpm build:stage
|
||||
|
||||
# 构建正式环境
|
||||
# build the prod environment
|
||||
pnpm build:prod
|
||||
```
|
||||
|
||||
## 🔧 代码格式检查
|
||||
## 🔧 Code formatting check
|
||||
|
||||
```bash
|
||||
pnpm lint
|
||||
```
|
||||
|
||||
## Git 提交规范参考
|
||||
## Git commit specification reference
|
||||
|
||||
- `feat` 增加新的业务功能
|
||||
- `fix` 修复业务问题/BUG
|
||||
- `perf` 优化性能
|
||||
- `style` 更改代码风格, 不影响运行结果
|
||||
- `refactor` 重构代码
|
||||
- `revert` 撤销更改
|
||||
- `test` 测试相关, 不涉及业务代码的更改
|
||||
- `docs` 文档和注释相关
|
||||
- `chore` 更新依赖/修改脚手架配置等琐事
|
||||
- `workflow` 工作流改进
|
||||
- `ci` 持续集成相关
|
||||
- `types` 类型定义文件更改
|
||||
- `wip` 开发中
|
||||
- `feat` add new functions
|
||||
- `fix` Fix issues/bugs
|
||||
- `perf` Optimize performance
|
||||
- `style` Change the code style without affecting the running result
|
||||
- `refactor` Re-factor code
|
||||
- `revert` Undo changes
|
||||
- `test` Test related, does not involve changes to business code
|
||||
- `docs` Documentation and Annotation
|
||||
- `chore` Updating dependencies/modifying scaffolding configuration, etc.
|
||||
- `workflow` Work flow Improvements
|
||||
- `ci` CICD
|
||||
- `types` Type definition
|
||||
- `wip` In development
|
||||
|
||||
## 可有可无的群
|
||||
## Group
|
||||
|
||||
QQ 群：1014374415（左）&& 加我微信，拉你进微信群（右）
|
||||
QQ group：1014374415（left）&& add me on WeChat，Invite you to join WeChat group（right）
|
||||
|
||||
|
||||
|
||||
|
||||
128
README.zh-CN.md
Normal file
128
README.zh-CN.md
Normal file
@ -0,0 +1,128 @@
|
||||
## ⚡ 简介
|
||||
|
||||
<p align="center">
|
||||
<span><a href="./README.md">English</a> | 中文</span>
|
||||
</p>
|
||||
|
||||
一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite 等主流技术.
|
||||
|
||||
- Vue-Cli 5.x 版: [v3-admin](https://github.com/un-pany/v3-admin)
|
||||
- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
|
||||
|
||||
## 特性
|
||||
|
||||
- **Vue3**：采用 Vue3 + script setup 最新的 Vue3 组合式 API
|
||||
- **Element Plus**：Element UI 的 Vue3 版本
|
||||
- **Pinia**: 传说中的 Vuex5
|
||||
- **Vite**：真的很快
|
||||
- **Vue Router**：路由路由
|
||||
- **TypeScript**：JavaScript 语言的超集
|
||||
- **PNPM**：更快速的，节省磁盘空间的包管理工具
|
||||
- **Scss**：和 Element Plus 保持一致
|
||||
- **CSS 变量**：主要控制项目的布局和颜色
|
||||
- **ESlint**：代码校验
|
||||
- **Prettier**：代码格式化
|
||||
- **Axios**：发送网络请求（已封装好）
|
||||
- **UnoCSS**：具有高性能且极具灵活性的即时原子化 CSS 引擎
|
||||
- **注释**：各个配置项都写有尽可能详细的注释
|
||||
- **兼容移动端**: 布局兼容移动端页面分辨率
|
||||
|
||||
## 功能
|
||||
|
||||
- **用户管理**：登录、登出演示
|
||||
- **权限管理**：内置页面权限（动态路由）、指令权限、权限函数、路由守卫
|
||||
- **多环境**：开发环境（development）、预发布环境（staging）、正式环境（production）
|
||||
- **多主题**：内置普通、黑暗两种主题模式
|
||||
- **错误页面**: 403、404
|
||||
- **Dashboard**：根据不同用户显示不同的 Dashboard 页面
|
||||
- **其他内置功能**：SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏
|
||||
|
||||
## 📚 文档
|
||||
|
||||
[中文文档](https://juejin.cn/post/7089377403717287972)
|
||||
|
||||
## 国内仓库
|
||||
|
||||
[Gitee](https://gitee.com/un-pany/v3-admin-vite)
|
||||
|
||||
## 在线预览
|
||||
|
||||
| 位置 | 账号 | 链接 |
|
||||
| ------------ | --------------- | ----------------------------------------------- |
|
||||
| github-pages | admin 或 editor | [链接](https://un-pany.github.io/v3-admin-vite) |
|
||||
|
||||
## 🚀 开发
|
||||
|
||||
```bash
|
||||
# 配置
|
||||
1. 一键安装 .vscode 目录中推荐的插件
|
||||
3. node 版本 16+
|
||||
4. pnpm 版本 7.x
|
||||
|
||||
# 克隆项目
|
||||
git clone https://github.com/un-pany/v3-admin-vite.git
|
||||
|
||||
# 进入项目目录
|
||||
cd v3-admin-vite
|
||||
|
||||
# 安装依赖
|
||||
pnpm i
|
||||
|
||||
# 启动服务
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## ✔️ 预览
|
||||
|
||||
```bash
|
||||
# 预览预发布环境
|
||||
pnpm preview:stage
|
||||
|
||||
# 预览正式环境
|
||||
pnpm preview:prod
|
||||
```
|
||||
|
||||
## 📦️ 多环境打包
|
||||
|
||||
```bash
|
||||
# 构建预发布环境
|
||||
pnpm build:stage
|
||||
|
||||
# 构建正式环境
|
||||
pnpm build:prod
|
||||
```
|
||||
|
||||
## 🔧 代码格式检查
|
||||
|
||||
```bash
|
||||
pnpm lint
|
||||
```
|
||||
|
||||
## Git 提交规范参考
|
||||
|
||||
- `feat` 增加新的业务功能
|
||||
- `fix` 修复业务问题/BUG
|
||||
- `perf` 优化性能
|
||||
- `style` 更改代码风格, 不影响运行结果
|
||||
- `refactor` 重构代码
|
||||
- `revert` 撤销更改
|
||||
- `test` 测试相关, 不涉及业务代码的更改
|
||||
- `docs` 文档和注释相关
|
||||
- `chore` 更新依赖/修改脚手架配置等琐事
|
||||
- `workflow` 工作流改进
|
||||
- `ci` 持续集成相关
|
||||
- `types` 类型定义文件更改
|
||||
- `wip` 开发中
|
||||
|
||||
## 可有可无的群
|
||||
|
||||
QQ 群：1014374415（左）&& 加我微信，拉你进微信群（右）
|
||||
|
||||
|
||||
|
||||
|
||||
## 📄 License
|
||||
|
||||
[MIT](https://github.com/un-pany/v3-admin-vite/blob/main/LICENSE)
|
||||
|
||||
Copyright (c) 2022 pany
|
||||
132
README_en.md
132
README_en.md
@ -1,132 +0,0 @@
|
||||
## ⚡ Introduction
|
||||
|
||||
<p align="center">
|
||||
<span><a href="./README.md">中文</a> | English</span>
|
||||
</p>
|
||||
v3-admin-vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element-Plus, Pinia and Vite.
|
||||
|
||||
The template code was migrated from [v3-admin ](https://github.com/un-pany/v3-admin), the scaffolding was switched from Vue-Cli 5.x to Vite 3.x, and some tedious adaptations were made.
|
||||
|
||||
We recommend everyone to use this Vite version! The focus of the future will be shifted from [v3-admin ](https://github.com/un-pany/v3-admin) to this repository.
|
||||
|
||||
- Electron desktop edition: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
|
||||
|
||||
## 🚀 Characteristics
|
||||
|
||||
- **Vue3**：The latest Vue3 composition API using Vue3 + script setup
|
||||
- **Element Plus**：Vue3 version of Element UI
|
||||
- **Pinia**: An alternative to Vuex in Vue3
|
||||
- **Vite**：Really fast
|
||||
- **Vue Router**：router
|
||||
- **TypeScript**：JavaScript With Syntax For Types
|
||||
- **PNPM**：Faster, disk space saving package management tool
|
||||
- **Scss**：Consistent with Element Plus
|
||||
- **CSS variable**：Mainly controls the layout and color of the item
|
||||
- **ESlint**：Code verification
|
||||
- **Prettier**： Code formatting
|
||||
- **Axios**: Promise based HTTP client（encapsulated）
|
||||
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
|
||||
- **Annotation**：Each configuration item is written with as detailed comments as possible
|
||||
|
||||
## 🔧 Functions
|
||||
|
||||
- **User management**: log in, log out of the demo
|
||||
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
|
||||
- **Multiple Environments**: Development、staging、production
|
||||
- **Multiple themes**: normal and dark theme modes
|
||||
- **Error page**: 403、404
|
||||
- **Dashboard**: Display different Dashboard pages according to different users
|
||||
- **Other functions**：SVG、Dynamic Sidebar、Dynamic Breadcrumb Navigation、Tabbed Navigation、Screenfull、Adaptive Shrink Sidebar (Mobile Compatible)
|
||||
|
||||
## 📚 Document
|
||||
|
||||
[掘金 Juijin](https://juejin.cn/post/7089377403717287972)
|
||||
|
||||
## Gitee repository
|
||||
|
||||
[Gitee](https://gitee.com/un-pany/v3-admin-vite)
|
||||
|
||||
## preview
|
||||
|
||||
| Location | account | Link |
|
||||
| ------------ | ------------------- | ----------------------------------------------- |
|
||||
| github-pages | `admin` or `editor` | [Link](https://un-pany.github.io/v3-admin-vite) |
|
||||
|
||||
## 🚀 Development
|
||||
|
||||
```bash
|
||||
# configure
|
||||
1. installation of the recommended plugins in the .vscode directory
|
||||
3. node version 16+
|
||||
4. pnpm version 7.x
|
||||
|
||||
# clone
|
||||
git clone https://github.com/un-pany/v3-admin-vite.git
|
||||
|
||||
# enter the project directory
|
||||
cd v3-admin-vite
|
||||
|
||||
# install dependencies
|
||||
pnpm i
|
||||
|
||||
# initialize husky
|
||||
pnpm prepare
|
||||
|
||||
# start the service
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## ✔️ Preview
|
||||
|
||||
```bash
|
||||
# stage environment
|
||||
pnpm preview:stage
|
||||
|
||||
# prod environment
|
||||
pnpm preview:prod
|
||||
```
|
||||
|
||||
## 📦️ Multi-environment packaging
|
||||
|
||||
```bash
|
||||
# build the stage environment
|
||||
pnpm build:stage
|
||||
|
||||
# build the prod environment
|
||||
pnpm build:prod
|
||||
```
|
||||
|
||||
## 🔧 Code formatting check
|
||||
|
||||
```bash
|
||||
pnpm lint
|
||||
```
|
||||
|
||||
## Git commit specification reference
|
||||
|
||||
- `feat` add new functions
|
||||
- `fix` Fix issues/bugs
|
||||
- `perf` Optimize performance
|
||||
- `style` Change the code style without affecting the running result
|
||||
- `refactor` Re-factor code
|
||||
- `revert` Undo changes
|
||||
- `test` Test related, does not involve changes to business code
|
||||
- `docs` Documentation and Annotation
|
||||
- `chore` Updating dependencies/modifying scaffolding configuration, etc.
|
||||
- `workflow` Work flow Improvements
|
||||
- `ci` CICD
|
||||
- `types` Type definition
|
||||
- `wip` In development
|
||||
|
||||
## group
|
||||
|
||||
QQ group：1014374415（left）&& add me on WeChat，Invite you to join WeChat group（right）
|
||||
|
||||
|
||||
|
||||
|
||||
## 📄 License
|
||||
|
||||
[MIT](https://github.com/un-pany/v3-admin-vite/blob/main/LICENSE)
|
||||
|
||||
Copyright (c) 2022 pany
|
||||
Loading…
x
Reference in New Issue
Block a user