fix: 调整README文件
This commit is contained in:
@@ -1,47 +1,89 @@
|
||||
<h1>vue-pure-admin Lite Edition（i18n version）</h1>
|
||||
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)
|
||||
## 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)
|
||||
|
||||
Reference in New Issue
Block a user