diff --git a/README.en-US.md b/README.en-US.md
index d07f5550..0a92b177 100644
--- a/README.en-US.md
+++ b/README.en-US.md
@@ -3,15 +3,15 @@
vue3-element-admin
- 
- 
+ 
+ 
- 
+
@@ -19,65 +19,90 @@
-
+
+
-
-
## Introduction
-[vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) is a free and open-source admin template for backend management frontend, built with popular technologies such as Vue3, Vite5, TypeScript, Element-Plus, and Pinia (with accompanying [backend source code](https://gitee.com/youlaiorg/youlai-boot)).
-
-
+[vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) is a minimalist enterprise-level backend management frontend template built with Vue3, Vite, TypeScript, and Element-Plus. It comes with complementary Java backend [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) and Node backend [youlai-nest](https://gitee.com/youlaiorg/youlai-nest). A simplified version [vue3-element-template](https://gitee.com/youlaiorg/vue3-element-template) and a JavaScript version [vue3-element-admin-js](https://gitee.com/youlaiorg/vue3-element-admin) are also available for developers to quickly start development.
## Project Features
- **Simple and Easy-to-use**: Upgraded version of [vue-element-admin](https://gitee.com/panjiachen/vue-element-admin) for Vue3, with minimal encapsulation and easy to get started.
+- **Data Interaction**: Support for `Mock` data and [online API documentation](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5), with accompanying [Java](https://gitee.com/youlaiorg/youlai-boot) and [Node](https://gitee.com/youlaiorg/youlai-nest) backend source code.
-- **Data Interaction**: Support both local `Mock` data and remote API. Comes with [Java backend source code](https://gitee.com/youlaiorg/youlai-boot) and online API documentation.
+- **System Functions**: Provides user management, role management, menu management, department management, dictionary management, and other functional modules.
+- **Permission Management**: Supports dynamic routing, button permissions, role permissions, and data permissions.
-- **Permission Management**: Complete permission system for users, roles, menus, dictionaries, and departments.
+- **Infrastructure**: Provides internationalization, multiple layouts, dark mode, full screen, watermark, API documentation, and code generator functionality.
+- **Continuous Updates**: Project is continuously updated with real-time updates of tools and dependencies.
-- **Essential Infrastructure**: Dynamic routing, button permissions, internationalization, code style, Git commit conventions, and common component encapsulation.
-- **Continuous Updates**: Since 2021, the project has maintained an open-source status with continuous updates, integrating new tools and dependencies in real time, and has accumulated a broad user base.
+## Project Screenshots
-## Project Preview
+🖥️ **Dashboard**
-
+
-
+⚡**API Documentation**
-
+
-## Project Links
+📲 **Mobile Version**
-| Project | Gitee | Github | GitCode |
-|----------| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| Frontend | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.net/youlai/vue3-element-admin) |
-| Lite | [vue3-element-template](https://gitee.com/youlaiorg/vue3-element-template) | [vue3-element-template](https://github.com/youlaitech/vue3-element-template) |-|
-| Backend | [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | [youlai-boot](https://github.com/haoxianrui/youlai-boot.git) | [youlai-boot](https://gitcode.net/youlai/youlai-boot) |
+
-## Environment Setup
+## Project Source Code
+
+| Project | Gitee | Github | GitCode|
+| ---- | ----| ---- | ---- |
+| vue3-element-admin ✅| [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) |
+| vue3-element-admin JS Version| [vue3-element-admin-js](https://gitee.com/youlaiorg/vue3-element-admin-js) | [vue3-element-admin-js](https://github.com/youlaitech/vue3-element-admin-js) | [vue3-element-admin-js](https://gitcode.com/youlai/vue3-element-admin-js) |
+| vue3-element-admin Lite Version | [vue3-element-template](https://gitee.com/youlaiorg/vue3-element-template) | [vue3-element-template](https://github.com/youlaitech/vue3-element-template) |[vue3-element-template](https://gitcode.com/youlai/vue3-element-template)|
+| vue-uniapp-admin Mobile Version | [vue-uniapp-admin](https://gitee.com/youlaiorg/vue-uniapp-admin) | [vue-uniapp-admin](https://github.com/youlaitech/vue-uniapp-admin) |[vue-uniapp-admin](https://gitcode.com/youlai/vue-uniapp-admin)|
+| Java Backend | [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | [youlai-boot](https://github.com/haoxianrui/youlai-boot.git) |[youlai-boot](https://gitcode.com/youlai/youlai-boot.git)|
+| Node Backend | [youlai-nest](https://gitee.com/youlaiorg/youlai-nest) | [youlai-nest](https://github.com/haoxianrui/youlai-nest.git) |[youlai-nest](https://gitcode.com/youlai/youlai-nest.git)|
+
+
+
+## Development Guide
+
+| Name | Link |
+|---------------|--------------------|
+| Video Tutorial | [https://www.bilibili.com/video/BV1eFUuYyEFj](https://www.bilibili.com/video/BV1eFUuYyEFj) |
+| Project Setup | [Building a Backend Management System from Scratch with Vue3, Vite, TypeScript, and Element-Plus](https://blog.csdn.net/u013737132/article/details/130191394) |
+| Official Documentation | [https://www.youlai.tech/vue3-element-admin/](https://www.youlai.tech/vue3-element-admin/) |
+| Code Standards | [ESLint V9 + Prettier + Stylelint + EditorConfig for Standardized and Unified Frontend Code Style](https://youlai.blog.csdn.net/article/details/145608723) |
+| Commit Standards | [Husky + Lint-staged + Commitlint + Commitizen + cz-git for Git Commit Standards](https://youlai.blog.csdn.net/article/details/145615236) |
+| API Documentation | [https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5) |
-| Environment | Name and Version | Download Link |
-| -------------------- | :----------------------------------------------------------- | ------------------------------------------------------------ |
-| **Development Tool** | VSCode | [Download](https://code.visualstudio.com/Download) |
-| **Runtime Environment** | Node ≥18 | [Download](http://nodejs.cn/download) |
## Project Setup
+
+- **Environment Preparation**
+
+| Environment Type | Name |
+|----------------|-----------------------------|
+| **Development Tool** | [Visual Studio Code](https://code.visualstudio.com/Download) |
+| **Runtime Environment** | Node 18 + (Recommended [22.9.0](https://npmmirror.com/mirrors/node/v22.9.0/)) |
+> ⚠️ Note: Node.js version 20.6.0 has compatibility issues, please don't use it
+
+
+- **Quick Start**
+
```bash
-# Clone the repository
+# Clone repository
git clone https://gitee.com/youlaiorg/vue3-element-admin.git
# Change directory
@@ -86,48 +111,59 @@ cd vue3-element-admin
# Install pnpm
npm install pnpm -g
+# Set mirror source (optional)
+pnpm config set registry https://registry.npmmirror.com
+
# Install dependencies
pnpm install
-# Start the project
+# Start development server
pnpm run dev
```
+
## Project Deployment
+After executing the `pnpm run build` command, the project will be bundled and a `dist` directory will be generated. Next, upload the files from the `dist` directory to the `/usr/share/nginx/html` directory on your server and configure Nginx for reverse proxy.
+
```bash
-# Build the project
pnpm run build
+```
-# Upload files to the remote server
-Copy the files generated in the `dist` directory to the `/usr/share/nginx/html` directory.
+Here is an example Nginx configuration:
-# nginx.cofig configuration
+```nginx
server {
- listen 80;
- server_name localhost;
- location / {
- root /usr/share/nginx/html;
- index index.html index.htm;
- }
- # Reverse proxy configuration
- location /prod-api/ {
- proxy_pass http://vapi.youlai.tech/; # Replace vapi.youlai.tech with your backend API address
- }
+ listen 80;
+ server_name localhost;
+
+ location / {
+ root /usr/share/nginx/html;
+ index index.html index.htm;
+ }
+
+ # Reverse proxy configuration
+ location /prod-api/ {
+ # Please replace api.youlai.tech with your backend API address, and keep the trailing slash /
+ proxy_pass http://api.youlai.tech/;
+ }
}
```
+For more detailed information, please refer to this article: [Nginx Installation and Configuration](https://blog.csdn.net/u013737132/article/details/145667694).
+
## Local Mock
-The project supports both online API and local mock API. By default, it uses the online API. If you want to switch to the mock API, modify the value of `VITE_MOCK_DEV_SERVER` in the `.env.development` file to `true`.
+The project supports both online and local Mock interfaces. By default, it uses online interfaces. To switch to Mock interfaces, modify the `VITE_MOCK_DEV_SERVER` value in the `.env.development` file to `true`.
## Backend API
-> If you have a basic understanding of Java development, follow these steps to convert online API to local backend API and set up a full-stack development environment.
+> If you have a basic understanding of Java development, follow these steps to convert online API to local backend API and create an enterprise-level full-stack development environment to help you on your full-stack journey.
1. Get the backend source code based on `Java` and `SpringBoot` from [youlai-boot](https://gitee.com/youlaiorg/youlai-boot.git).
-2. Follow the instructions in the backend project's README.md to set up the local environment.
-3. Modify the value of `VITE_APP_API_URL` in the `.env.development` file to `http://localhost:8989`, replacing it with the backend API URL.
+2. Follow the instructions in the backend project's README.md to [set up and run locally](https://gitee.com/youlaiorg/youlai-boot#%E9%A1%B9%E7%9B%AE%E8%BF%90%E8%A1%8C).
+3. Modify the value of `VITE_APP_API_URL` in the `.env.development` file, changing it from https://api.youlai.tech to http://localhost:8989.
+
## Notes
@@ -141,20 +177,18 @@ The project supports both online API and local mock API. By default, it uses the
Try upgrading your browser, as older browser engines may not support certain new JavaScript syntax, such as optional chaining operator `?.`.
+- **Project synchronization with repository updates**
+
+ After synchronizing the project with repository updates, it is recommended to run `pnpm install` to update dependencies before starting.
+
- **Red highlight on project components, functions, and imports**
Restart VSCode to try again.
- **Other issues**
- If you have any other issues or suggestions, please open an [issue](https://gitee.com/youlaiorg/vue3-element-admin/issues/new).
+ If you have any other issues or suggestions, please open an [ISSUE](https://gitee.com/youlaiorg/vue3-element-admin/issues/new).
-## Project Documentation
-
-- [Building a Backend Management System from Scratch with Vue3, Vite, TypeScript, and Element-Plus](https://blog.csdn.net/u013737132/article/details/130191394)
-
-- [ESLint+Prettier+Stylelint+EditorConfig for Standardized and Unified Frontend Code Style](https://blog.csdn.net/u013737132/article/details/130190788)
-- [Git Commit Conventions with Husky, Lint-staged, Commitlint, Commitizen, and cz-git](https://blog.csdn.net/u013737132/article/details/130191363)
## Commit Conventions
@@ -162,15 +196,27 @@ Execute `pnpm run commit` to invoke interactive git commit and complete the info
-## Community 🚀
-> **Follow "Youlai Tech" WeChat Official Account to get the QR code for the community.**
->
-> If the QR code for the community has expired, please add my WeChat (haoxianrui) and indicate whether you are interested in "Frontend", "Backend", or "Full Stack" to get the latest QR code.
->
-> This measure is taken to ensure the quality of the community and prevent marketing advertising from infiltrating. Thank you for your understanding!
+## Project Statistics
-| Official Account | Community |
-|:----:|:----:|
-|  |  |
+
+
+
+Thanks to all the contributors!
+
+[](https://github.com/youlaitech/vue3-element-admin/graphs/contributors)
+
+
+## Special Thanks
+
+- Thanks to the [GitCode](https://gitcode.com/) official [G-Star](https://gitcode.com/g-star) certification
+ 
+
+## Community
+
+① Follow the "Youlai Tech" WeChat Official Account, click the **Group Chat** menu to get the QR code (this measure is taken to prevent ads from entering the group, thanks for your understanding and support).
+
+② Directly add WeChat **`haoxianrui`** with a note indicating "Frontend/Backend/Full Stack".
+
+