From c43ee2bb30a6c7f826a54e209a89f23c6d10d26a Mon Sep 17 00:00:00 2001
From: pany <939630029@qq.com>
Date: Thu, 5 Dec 2024 16:24:10 +0800
Subject: [PATCH] =?UTF-8?q?docs:=205.0=20=E8=8B=B1=E6=96=87=E8=87=AA?=
=?UTF-8?q?=E8=BF=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 271 +++++++++++++++++++++++++++++-------------------
README.zh-CN.md | 2 +-
2 files changed, 166 insertions(+), 107 deletions(-)
diff --git a/README.md b/README.md
index 52529b69..76b8b184 100644
--- a/README.md
+++ b/README.md
@@ -1,159 +1,218 @@
-
+
V3 Admin Vite
-
English | 中文
+Recommended Environment
-## Feature
+
-- **Vue3**：The latest Vue3 composition API using Vue3 + script setup
-- **Element Plus**：Vue3 version of Element UI
-- **Pinia**: An alternative to Vuex in Vue3
-- **Vite**：Really fast
-- **Vue Router**：router
-- **TypeScript**：JavaScript With Syntax For Types
-- **pnpm**：Faster, disk space saving package management tool
-- **Scss**：Consistent with Element Plus
-- **CSS variable**：Mainly controls the layout and color of the item
-- **ESlint**：Code verification, Code formatting
-- **Axios**: Promise based HTTP client (encapsulated)
-- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
-- **Mobile Compatible**: The layout is compatible with mobile page resolution
+- Latest version of `Visual Studio Code`
+- Install the recommended plugins in the `.vscode/extensions.json` file
+- `node` 20.x or 22+
+- `pnpm` 9+
-## Functions
+
-- **User management**: Log in and out of the demo
-- **Authority management**: Page-level permissions (dynamic routing), button-level permissions (directive permissions, permission functions), and route navigation guards
-- **Multiple Environments**: Development, Staging, Production
-- **Multiple themes**: Normal, Dark, Dark Blue, three theme modes
-- **Multiple layouts**：Left, Top, Left Top, three layout modes
-- **Error page**: 403, 404
-- **Dashboard**: Display different Dashboard pages according to different users
-- **Other functions**：SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar, Composable
+
+Local Development
-## 🚀 Development
+
```bash
-# configure
-1. installation of the recommended plugins in the .vscode directory
-2. node version 18.x or 20+
-3. pnpm version 8.x or latest
-
-# clone
+# Clone the project
git clone https://github.com/un-pany/v3-admin-vite.git
-# enter the project directory
+# Enter the project directory
cd v3-admin-vite
-# install dependencies
+# Install dependencies
pnpm i
-# start the service
+# Start the development server
pnpm dev
```
-## ✔️ Preview
+
+
+
+Build for Production
+
+
```bash
-# staging environment
-pnpm preview:staging
-
-# production environment
-pnpm preview
-```
-
-## 📦️ Multi-environment packaging
-
-```bash
-# build the staging environment
+# Build for the staging environment
pnpm build:staging
-# build the production environment
+# Build for the production environment
pnpm build
```
-## 🔧 Code inspection
+
+
+
+Local Preview
+
+
```bash
-# code formatting
+# Execute the build command first to generate the dist directory, then run the preview command
+pnpm preview
+```
+
+
+
+
+Code Check
+
+
+
+```bash
+# Code linting and formatting
pnpm lint
-# unit test
+# Unit tests
pnpm test
```
-## Git commit specification reference
+
-- `feat` add new functions
-- `fix` Fix issues/bugs
-- `perf` Optimize performance
-- `style` Change the code style without affecting the running result
-- `refactor` Re-factor code
-- `revert` Undo changes
-- `test` Test related, does not involve changes to business code
-- `docs` Documentation and Annotation
-- `chore` Updating dependencies/modifying scaffolding configuration, etc.
-- `workflow` Work flow Improvements
-- `ci` CICD
-- `types` Type definition
-- `wip` In development
+
+Commit Guidelines
-## Project preview
+
-
-
-
+`feat` New feature
-## 💕 Contributors
+`fix` Bug fix
-Thanks to all the contributors!
+`perf` Performance improvement
+
+`refactor` Code refactoring
+
+`docs` Documentation and comments
+
+`types` Type-related changes
+
+`test` Unit tests related
+
+`ci` Continuous integration, workflows
+
+`revert` Revert changes
+
+`chore` Chores (update dependencies, modify configurations, etc)
+
+
+
+## Links
+
+**Online Preview**：[github-pages](https://un-pany.github.io/v3-admin-vite)
+
+**Chinese Documentation**：[link](https://juejin.cn/post/7089377403717287972)
+
+**Zero to Hero Tutorial**：[link](https://juejin.cn/column/7207659644487139387)
+
+**Electron Desktop Version**: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
+
+**Domestic Repository**：[gitee](https://gitee.com/un-pany/v3-admin-vite)
+
+**Optional Group**：[check how to join](https://github.com/un-pany/v3-admin-vite/issues/191)
+
+**Donations**：[buy a coffee for the author](https://github.com/un-pany/v3-admin-vite/issues/69)
+
+**Releases & Changelog**：[releases](https://github.com/un-pany/v3-admin-vite/releases)
+
+## Features
+
+**Simplified structure**: No complex encapsulation, no complicated type gymnastics, just enough to meet the needs
+
+**Detailed comments**: Every configuration item comes with as detailed comments as possible
+
+**Latest dependencies**: Keeps all third-party dependencies up to date
+
+**Consistency**: Unified code style, naming conventions, and comment style
+
+## Built-in Features
+
+**User Management**: Login, logout demonstration
+
+**Permission Management**: Page-level permissions (dynamic routing), button-level permissions (directive permissions, permission functions), route guards
+
+**Multiple Environments**: Development, staging, and production environments
+
+**Multiple Themes**: Normal, dark, and deep blue themes
+
+**Multiple Layouts**: Left-side, top, and hybrid layouts
+
+**Homepage**: Different dashboard pages for different users
+
+**Error Pages**: 403, 404
+
+**Mobile Compatibility**: Layouts compatible with mobile screen resolutions
+
+**Others**: SVG sprite sheet, dynamic sidebar, dynamic breadcrumbs, tab navigation, content zoom and fullscreen, composable functions
+
+## Tech Stack
+
+**Vue3**: Vue3 + script setup with the latest Vue3 Composition API
+
+**Element Plus**: The Vue3 version of Element UI
+
+**Pinia**: The legendary Vuex5
+
+**Vite**: Really fast
+
+**Vue Router**: The routing system
+
+**TypeScript**: A superset of JavaScript
+
+**pnpm**: A faster, disk-space-saving package manager
+
+**Scss**: Consistent with Element Plus
+
+**CSS Variables**: Primarily controls layout and color in the project
+
+**ESlint**: Code linting and formatting
+
+**Axios**: Sends network requests (pre-packaged)
+
+**UnoCSS**: A high-performance, flexible atomic CSS engine
+
+## Project Preview Image
+
+
+
+## Contributors
+
+A big thank you to all the contributors!
- 
+
-## 💕 Thanks star
+## License
-Small projects are not easy to get a star, if you like this project, welcome to support a star! This is the only motivation for the author to maintain it on an ongoing basis (whisper: it's free after all)
-
-## ☕ Donate
-
-[See how to donate](https://github.com/un-pany/v3-admin-vite/issues/69)
-
-## Group
-
-[See how to join a group chat](https://github.com/un-pany/v3-admin-vite/issues/191)
-
-## 📄 License
-
-[MIT](./LICENSE)
-
-Copyright (c) 2022-present [pany](https://github.com/pany-ang)
+[MIT](./LICENSE) License © 2022-PRESENT [pany](https://github.com/pany-ang)
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 52568134..7d6c54e9 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -1,5 +1,5 @@
-
+
V3 Admin Vite