diff --git a/README.en-US.md b/README.en-US.md index 290478a..4b77fa6 100644 --- a/README.en-US.md +++ b/README.en-US.md @@ -1,47 +1,89 @@ -

vue-pure-admin Lite Edition(i18n version)

+This project is a simplified version based on the internationalized version of [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin), focusing on core functionalities and suitable for actual project development. -[![license](https://img.shields.io/github/license/pure-admin/vue-pure-admin.svg)](LICENSE) +## Installation -**English** | [中文](./README.md) +Please ensure you have installed the following tools: -## Introduce +- **Node.js** >=18.18.0 or >=20.9.0 or >=22.0.0 +- **pnpm** >=9 -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` +### 1. Install Dependencies -## `js` version +Run the following command in the project root directory to install all dependencies: -[Click me to view js version](https://pure-admin.cn/pages/js/) +```bash +pnpm install +``` -## `max` version +This command will restore the dependency environment exactly according to the [pnpm-lock.yaml](./pnpm-lock.yaml) file, ensuring consistent builds. -[Click me to view the max version](https://pure-admin.cn/pages/max/) +--- -## Supporting video +## Running the Project -[Click me to view UI design](https://www.bilibili.com/video/BV17g411T7rq) -[Click me to view the rapid development tutorial](https://www.bilibili.com/video/BV1kg411v7QT) +### 2. Start the Development Server -## Nanny-level documents +```bash +pnpm dev +``` -[Click me to view vue-pure-admin documentation](https://pure-admin.cn/) -[Click me to view @pureadmin/utils documentation](https://pure-admin-utils.netlify.app) +This will start the local development server, accessible by default at: [http://localhost](http://localhost) -## Quality service, software outsourcing, sponsorship support +--- -[Click me to view details](https://pure-admin.cn/pages/service/) +## Building for Production -## Preview +If you need to build static resources for production, use the following commands: -[Click me to view the preview station](https://pure-admin-thin.netlify.app/#/login) +```bash +pnpm build +``` -## Maintainer +To build for the staging environment: -[xiaoxian521](https://github.com/xiaoxian521) +```bash +pnpm build:staging +``` -## ⚠️ Attention +After the build process completes, the generated files will be placed in the [dist/](./dist) directory. -The Lite version does not accept any issues and prs. If you have any questions, please go to the full version [issues](https://github.com/pure-admin/vue-pure-admin/issues/new/choose) to mention, thank you! +--- -## License +## Deploying with Docker -[MIT © 2020-present, pure-admin](./LICENSE) +This project supports quick deployment to an Nginx server using Docker. + +### 3. Build the Docker Image + +```bash +docker build -t frontend-template-i18n . +``` + +### 4. Run the Container + +```bash +docker run -d -p 80:80 frontend-template-i18n +``` + +--- + +## Technical Details + +- **Build Tool**: Vite + pnpm +- **Bundle Size**: Default <2.3MB, can be reduced to <350KB after enabling Brotli compression +- **UI Library**: Element Plus v2.9.0 +- **State Management**: Pinia v2.3.0 +- **Internationalization**: vue-i18n v10.0.5 +- **Styling Solution**: TailwindCSS + SCSS +- **HTTP Requests**: Axios + Localforage caching +- **Code Standards**: ESLint + Prettier + Stylelint + +--- + +## Notes + +- This template is a lightweight version and does not accept Issues or PRs; please submit feedback to the full version repository. +- For further performance optimization, consider enabling CDN mode or implementing lazy loading. +- Third-party libraries may have version compatibility issues; ensure functionality testing when updating dependencies. + +For detailed documentation, please refer to the [README.md](https://github.com/pure-admin/pure-admin-thin/tree/i18n) diff --git a/README.md b/README.md index 55a3d52..df47e4c 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,85 @@ -

vue-pure-admin精简版(国际化版本)

+该项目已经基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 精简版进行了国际化版本的修改,使用 `pnpm` 安装依赖即可快速启动项目。以下是安装和运行步骤: -[![license](https://img.shields.io/github/license/pure-admin/vue-pure-admin.svg)](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) 文件。