fix: 调整README文件
This commit is contained in:
88
README.md
88
README.md
@@ -1,51 +1,85 @@
|
||||
<h1>vue-pure-admin精简版(国际化版本)</h1>
|
||||
该项目已经基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 精简版进行了国际化版本的修改,使用 `pnpm` 安装依赖即可快速启动项目。以下是安装和运行步骤:
|
||||
|
||||
[](LICENSE)
|
||||
### 安装
|
||||
|
||||
**中文** | [English](./README.en-US.md)
|
||||
请确保你已安装以下工具:
|
||||
|
||||
## 介绍
|
||||
- **Node.js** >=18.18.0 或 >=20.9.0 或 >=22.0.0
|
||||
- **pnpm** >=9
|
||||
|
||||
精简版是基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 提炼出的架子,包含主体功能,更适合实际项目开发,打包后的大小在全局引入 [element-plus](https://element-plus.org) 的情况下仍然低于 `2.3MB`,并且会永久同步完整版的代码。开启 `brotli` 压缩和 `cdn` 替换本地库模式后,打包大小低于 `350kb`
|
||||
#### 1. 安装依赖
|
||||
|
||||
## 版本选择
|
||||
在项目根目录下运行以下命令以安装所有依赖:
|
||||
|
||||
当前是国际化版本,如果您需要非国际化版本 [请点击](https://github.com/pure-admin/pure-admin-thin)
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## `js` 版本
|
||||
该命令会根据 [pnpm-lock.yaml](./pnpm-lock.yaml) 文件精确还原依赖环境,保证构建的一致性。
|
||||
|
||||
[点我查看 js 版本](https://pure-admin.cn/pages/js/)
|
||||
---
|
||||
|
||||
## `max` 版本
|
||||
### 运行项目
|
||||
|
||||
[点我查看 max 版本](https://pure-admin.cn/pages/max/)
|
||||
#### 2. 启动本地开发服务器
|
||||
|
||||
## 配套视频
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
[点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq)
|
||||
[点我查看快速开发教程](https://www.bilibili.com/video/BV1kg411v7QT)
|
||||
这将启动本地开发服务器,默认访问地址为:[http://localhost](http://localhost)
|
||||
|
||||
## 配套保姆级文档
|
||||
---
|
||||
|
||||
[点我查看 vue-pure-admin 文档](https://pure-admin.cn/)
|
||||
[点我查看 @pureadmin/utils 文档](https://pure-admin-utils.netlify.app)
|
||||
### 构建生产环境包
|
||||
|
||||
## 优质服务、软件外包、赞助支持
|
||||
如果你需要构建用于生产的静态资源包,可以使用以下命令:
|
||||
|
||||
[点我查看详情](https://pure-admin.cn/pages/service/)
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## 预览
|
||||
如果需要构建 staging 测试环境版本:
|
||||
|
||||
[查看预览](https://pure-admin-thin.netlify.app/#/login)
|
||||
```bash
|
||||
pnpm build:staging
|
||||
```
|
||||
|
||||
## 维护者
|
||||
构建完成后,生成的文件会存放在 [dist/](./dist) 目录中。
|
||||
|
||||
[xiaoxian521](https://github.com/xiaoxian521)
|
||||
---
|
||||
|
||||
## ⚠️ 注意
|
||||
### 部署到 Docker
|
||||
|
||||
精简版不接受任何 `issues` 和 `pr`,如果有问题请到完整版 [issues](https://github.com/pure-admin/vue-pure-admin/issues/new/choose) 去提,谢谢!
|
||||
本项目支持通过 Docker 快速部署到 Nginx 服务器。
|
||||
|
||||
## 许可证
|
||||
#### 3. 构建 Docker 镜像
|
||||
|
||||
[MIT © 2020-present, pure-admin](./LICENSE)
|
||||
```bash
|
||||
docker build -t frontend-template-i18n .
|
||||
```
|
||||
|
||||
#### 4. 运行容器
|
||||
|
||||
```bash
|
||||
docker run -d -p 80:80 frontend-template-i18n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 技术说明
|
||||
|
||||
- **构建工具**: Vite + pnpm
|
||||
- **打包体积**: 默认小于 2.3MB,启用 Brotli 压缩后可缩小至 350KB 以下
|
||||
- **UI库**: Element Plus v2.9.0
|
||||
- **状态管理**: Pinia v2.3.0
|
||||
- **国际化**: vue-i18n v10.0.5
|
||||
- **样式方案**: TailwindCSS + SCSS
|
||||
- **HTTP请求**: Axios + Localforage 缓存
|
||||
- **代码规范**: ESLint + Prettier + Stylelint
|
||||
|
||||
---
|
||||
|
||||
### 注意事项
|
||||
|
||||
如需查看详细文档,请参考 [README.md](https://github.com/pure-admin/pure-admin-thin/tree/i18n) 文件。
|
||||
|
||||
Reference in New Issue
Block a user