From f17eda34b4ae38f78042b00a0f345634225b8d98 Mon Sep 17 00:00:00 2001 From: xiaoxian521 <1923740402@qq.com> Date: Wed, 3 Jan 2024 16:12:28 +0800 Subject: [PATCH] docs: update `README` --- README.en-US.md | 107 +++++++++++++++++++++++++++---------------- README.md | 117 ++++++++++++++++++++++++++++++------------------ 2 files changed, 141 insertions(+), 83 deletions(-) diff --git a/README.en-US.md b/README.en-US.md index 91cc73f76..d94601fde 100644 --- a/README.en-US.md +++ b/README.en-US.md @@ -14,43 +14,48 @@ The simplified version is based on the shelf extracted from [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin), which contains main functions and is more suitable for actual project development. The packaged size is introduced globally [element-plus](https://element-plus.org) is still below `2.3MB`, and the full version of the code will be permanently synchronized. After enabling `brotli` compression and `cdn` to replace the local library mode, the package size is less than `350kb` -- [Click me to view the non-internationalized version](https://github.com/pure-admin/pure-admin-thin) -- [Click me to view Internationalization version](https://github.com/pure-admin/pure-admin-thin/tree/i18n) +[Click to view the non-internationalized version](https://github.com/pure-admin/pure-admin-thin) +[Click to view Internationalization version](https://github.com/pure-admin/pure-admin-thin/tree/i18n) ## Supporting Video -- [Click Watch Tutorial](https://www.bilibili.com/video/BV1kg411v7QT) -- [Click Watch UI Design](https://www.bilibili.com/video/BV17g411T7rq) +[Click Watch Tutorial](https://www.bilibili.com/video/BV1kg411v7QT) +[Click Watch UI Design](https://www.bilibili.com/video/BV17g411T7rq) ## Docs -- [documentation site](https://yiming_chang.gitee.io/pure-admin-doc) +[View vue-pure-admin documentation](https://yiming_chang.gitee.io/pure-admin-doc) +[View @pureadmin/utils documentation](https://pure-admin-utils.netlify.app) ## Tauri -- [Click Watch Tauri](https://github.com/pure-admin/tauri-pure-admin) +[Click Watch Tauri](https://github.com/pure-admin/tauri-pure-admin) ## Electron -- [Click Watch Electron](https://github.com/pure-admin/electron-pure-admin) +[Click Watch Electron](https://github.com/pure-admin/electron-pure-admin) ## Preview -- [preview station](https://yiming_chang.gitee.io/vue-pure-admin) +[preview station](https://yiming_chang.gitee.io/vue-pure-admin) + +`PC` -- PC

- PureAdmin Logo + PureAdmin + PureAdmin

-- DarkMode +`DarkMode` +

- PureAdmin Logo + PureAdmin

-- Mobile +`Mobile` +

- PureAdmin Logo + PureAdmin

### Use Gitpod @@ -59,32 +64,56 @@ Open the project in Gitpod (free online dev environment for GitHub) and start co [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/pure-admin/vue-pure-admin) -## Install and use +## Install And Use -- Get the project code +### Pull code + +#### It is recommended to use `@pureadmin/cli` scaffolding + +
+pure-admin-cli + +1. Global installation + +```bash +npm install -g @pureadmin/cli +``` + +2. Interactively select templates and create projects + +```bash +pure create +``` + +[Click to view the detailed usage of @pureadmin/cli scaffolding](https://github.com/pure-admin/pure-admin-cli#pureadmincli) + +#### Pull from `GitHub` ```bash git clone https://github.com/pure-admin/vue-pure-admin.git -or +``` + +#### Pulled from `Gitee` + +```bash git clone https://gitee.com/yiming_chang/vue-pure-admin.git ``` -- Installation dependencies +### Install dependencies ```bash cd vue-pure-admin pnpm install - ``` -- run +### Run platform ```bash -pnpm serve +pnpm dev ``` -- build +### Project packaging ```bash pnpm build @@ -130,27 +159,27 @@ You are very welcome to join![Raise an issue](https://github.com/pure-admin/vu ## Git Contribution submission specification -- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) +reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) - - `feat` Add new features - - `fix` Fix the problem/BUG - - `style` The code style is related and does not affect the running result - - `perf` Optimization/performance improvement - - `refactor` Refactor - - `revert` Undo edit - - `test` Test related - - `docs` Documentation/notes - - `chore` Dependency update/scaffolding configuration modification etc. - - `workflow` Workflow improvements - - `ci` Continuous integration - - `types` Type definition file changes - - `wip` In development +- `feat` Add new features +- `fix` Fix the problem/BUG +- `style` The code style is related and does not affect the running result +- `perf` Optimization/performance improvement +- `refactor` Refactor +- `revert` Undo edit +- `test` Test related +- `docs` Documentation/notes +- `chore` Dependency update/scaffolding configuration modification etc. +- `workflow` Workflow improvements +- `ci` Continuous integration +- `types` Type definition file changes +- `wip` In development ## Browser support -The `Chrome 80+` browser is recommended for local development - -Support modern browsers, not IE +It is recommended to use `Chrome`, `Edge`, and `Firefox` browsers for local development. The author commonly uses the latest version of `Chrome` browser. +In actual use, I feel that `Firefox` is smoother in animation than other browsers, but the author is used to using `Chrome`. It depends on personal preference. +For more detailed browser compatibility support, please see [Which browsers does Vue support? ](https://vuejs.org/about/faq.html#what-browsers-does-vue-support) and [Vite browser compatibility](https://vitejs.dev/guide/build.html#browser-compatibility) | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | diff --git a/README.md b/README.md index dec90c22b..87f51f21b 100644 --- a/README.md +++ b/README.md @@ -10,81 +10,110 @@ `vue-pure-admin` 是一款开源免费且开箱即用的中后台管理系统模版。完全采用 `ECMAScript` 模块(`ESM`)规范来编写和组织代码,使用了最新的 `Vue3`、`Vite`、`Element-Plus`、`TypeScript`、`Pinia`、`Tailwindcss` 等主流技术开发 -## 精简版(实际项目开发请用精简版,提供 `非国际化` 、`国际化` 两个版本选择) +## 精简版本(实际项目开发请用精简版本,提供 `非国际化` 、`国际化` 两个版本选择) -精简版是基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 提炼出的架子,包含主体功能,更适合实际项目开发,打包后的大小在全局引入 [element-plus](https://element-plus.org) 的情况下仍然低于 `2.3MB`,并且会永久同步完整版的代码。开启 `brotli` 压缩和 `cdn` 替换本地库模式后,打包大小低于 `350kb` +精简版本是基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 提炼出的架子,包含主体功能,更适合实际项目开发,打包后的大小在全局引入 [element-plus](https://element-plus.org) 的情况下仍然低于 `2.3MB`,并且会永久同步完整版的代码。开启 `brotli` 压缩和 `cdn` 替换本地库模式后,打包大小低于 `350kb` -- [点我查看非国际化精简版](https://github.com/pure-admin/pure-admin-thin) -- [点我查看国际化精简版](https://github.com/pure-admin/pure-admin-thin/tree/i18n) +[点我查看非国际化精简版本](https://github.com/pure-admin/pure-admin-thin) +[点我查看国际化精简版本](https://github.com/pure-admin/pure-admin-thin/tree/i18n) ## 配套视频 -- [点我查看快速开发教程](https://www.bilibili.com/video/BV1kg411v7QT) -- [点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq) +[点我查看快速开发教程](https://www.bilibili.com/video/BV1kg411v7QT) +[点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq) ## 配套保姆级文档 -- [查看文档](https://yiming_chang.gitee.io/pure-admin-doc) +[查看 vue-pure-admin 文档](https://yiming_chang.gitee.io/pure-admin-doc) +[查看 @pureadmin/utils 文档](https://pure-admin-utils.netlify.app) -## `Tauri` 版 +## `Tauri` 版本 -- [点我查看 Tauri 版](https://github.com/pure-admin/tauri-pure-admin) +[点我查看 Tauri 版本](https://github.com/pure-admin/tauri-pure-admin) -## `Electron` 版 +## `Electron` 版本 -- [点我查看 Electron 版](https://github.com/pure-admin/electron-pure-admin) +[点我查看 Electron 版本](https://github.com/pure-admin/electron-pure-admin) ## 预览 -- [查看预览](https://yiming_chang.gitee.io/vue-pure-admin) +[查看预览](https://yiming_chang.gitee.io/vue-pure-admin) + +`PC` 端 -- PC 端

- PureAdmin Logo + PureAdmin + PureAdmin

-- 暗黑模式 +暗黑模式 +

- PureAdmin Logo + PureAdmin

-- 移动端 +移动端 +

- PureAdmin Logo + PureAdmin

### 使用 `Gitpod` -在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码. +在 `Gitpod`(适用于 `GitHub` 的免费在线开发环境)中打开项目,并立即开始编码. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/pure-admin/vue-pure-admin) ## 安装使用 -- 获取项目代码 +### 拉取代码 + +#### 推荐使用 `@pureadmin/cli` 脚手架 + +
+pure-admin-cli + +1. 全局安装 + +```bash +npm install -g @pureadmin/cli +``` + +2. 交互式选择模板并创建项目 + +```bash +pure create +``` + +[点我查看 @pureadmin/cli 脚手架详细用法](https://github.com/pure-admin/pure-admin-cli#pureadmincli) + +#### 从 `GitHub` 上拉取 ```bash git clone https://github.com/pure-admin/vue-pure-admin.git -or +``` + +#### 从 `Gitee` 上拉取 + +```bash git clone https://gitee.com/yiming_chang/vue-pure-admin.git ``` -- 安装依赖 +### 安装依赖 ```bash cd vue-pure-admin pnpm install - ``` -- 运行 +### 启动平台 ```bash -pnpm serve +pnpm dev ``` -- 打包 +### 项目打包 ```bash pnpm build @@ -130,31 +159,31 @@ docker run -dp 8080:80 --name pure-admin vue-pure-admin ## `Git` 贡献提交规范 -- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) +参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) - - `feat` 增加新功能 - - `fix` 修复问题/BUG - - `style` 代码风格相关无影响运行结果的 - - `perf` 优化/性能提升 - - `refactor` 重构 - - `revert` 撤销修改 - - `test` 测试相关 - - `docs` 文档/注释 - - `chore` 依赖更新/脚手架配置修改等 - - `workflow` 工作流改进 - - `ci` 持续集成 - - `types` 类型定义文件更改 - - `wip` 开发中 +- `feat` 增加新功能 +- `fix` 修复问题/BUG +- `style` 代码风格相关无影响运行结果的 +- `perf` 优化/性能提升 +- `refactor` 重构 +- `revert` 撤销修改 +- `test` 测试相关 +- `docs` 文档/注释 +- `chore` 依赖更新/脚手架配置修改等 +- `workflow` 工作流改进 +- `ci` 持续集成 +- `types` 类型定义文件更改 +- `wip` 开发中 ## 浏览器支持 -本地开发推荐使用 `Chrome 80+` 浏览器 - -支持现代浏览器, 不支持 `IE` +本地开发推荐使用 `Chrome`、`Edge`、`Firefox` 浏览器,作者常用的是最新版 `Chrome` 浏览器 +实际使用中感觉 `Firefox` 在动画上要比别的浏览器更加丝滑,只是作者用 `Chrome` 已经习惯了,看个人爱好选择吧 +更详细的浏览器兼容性支持请看 [Vue 支持哪些浏览器?](https://cn.vuejs.org/about/faq.html#what-browsers-does-vue-support) 和 [Vite 浏览器兼容性](https://cn.vitejs.dev/guide/build#browser-compatibility) | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | +| 不支持 | 最后两个版本 | 最后两个版本 | 最后两个版本 | 最后两个版本 | ## 维护者