ec53bf8084
* 优化简介中文文档 1. 优化文案及病句 2. 统一格式 * Optimize the introduction English document 1. Optimize copywriting and sentences 2. Uniform format
50 lines
4.4 KiB
Markdown
50 lines
4.4 KiB
Markdown
# About Vben Admin
|
|
|
|
::: info You are reading the documentation for [Vben Admin](https://github.com/vbenjs/vue-vben-admin) version `5.0`!
|
|
|
|
- Vben Admin 2.x is currently archived and only receives critical fixes.
|
|
- The new version is not compatible with the old version. If you are using the old version (v2, v3), please refer to the [Vue Vben Admin 2.x Documentation](https://doc.vvbin.cn).
|
|
- If you find any errors in the documentation, feel free to submit an issue to help us improve.
|
|
- If you just want to experience it, you can check out the [Quick Start](./quick-start.md).
|
|
|
|
:::
|
|
|
|
[Vben Admin](https://github.com/vbenjs/vue-vben-admin) is a backend solution based on [Vue 3.0](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), and [TypeScript](https://www.typescriptlang.org/), aimed at providing an out-of-the-box solution for developing medium to large-scale projects. It includes features like component re-encapsulation, utilities, hooks, dynamic menus, permission validation, multi-theme configurations, and button-level permission control. The project uses the latest frontend technology stack, making it a good starting template for quickly building enterprise-level mid- to backend product prototypes. It can also serve as an example for learning `vue3`, `vite`, `ts`, and other mainstream technologies. The project will continue to follow the latest technologies and apply them within the project.
|
|
|
|
## Features
|
|
|
|
- **Latest Technology Stack**: Developed using cutting-edge frontend technologies like `Vue 3`, `Vite`, and `TypeScript`.
|
|
- **Internationalization**: Built-in comprehensive internationalization solutions with multi-language support.
|
|
- **Permission Validation**: Comprehensive permission validation solutions, including button-level permission control.
|
|
- **Multi-Theme**: Built-in multiple theme configurations & dark mode to meet personalized needs.
|
|
- **Dynamic Menu**: Supports dynamic menus that can display based on permissions.
|
|
- **Mock Data**: High-performance local Mock data solution based on `Nitro`.
|
|
- **Rich Components**: Provides a wide range of components to meet most business needs.
|
|
- **Standardization**: Code quality is ensured with tools like `ESLint`, `Prettier`, `Stylelint`, `Publint`, and `CSpell`.
|
|
- **Engineering**: Development efficiency is improved with tools like `Pnpm Monorepo`, `TurboRepo`, and `Changeset`.
|
|
- **Multi-UI Library Support**: Supports mainstream UI libraries like `Ant Design Vue`, `Element Plus`, and `Vuetify`, without being restricted to a specific framework.
|
|
|
|
## Browser Support
|
|
|
|
- **Local development** is recommended using the **latest version of Chrome**. **Versions below Chrome 80 are not supported**.
|
|
|
|
- **Production environment** supports modern browsers, IE is not supported.
|
|
|
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png" alt="IE" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Safari |
|
|
| :-: | :-: | :-: | :-: | :-: |
|
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
|
|
|
## Contribution
|
|
|
|
- [Vben Admin](https://github.com/vbenjs/vue-vben-admin) is still being actively updated. Contributions are welcome to help maintain and improve the project, aiming to create a better mid- to backend solution.
|
|
- If you wish to join us, you can start by contributing in the following ways, and we will invite you to join based on your activity.
|
|
|
|
::: info Join Us
|
|
|
|
- Regularly submit `PRs`.
|
|
- Provide valuable suggestions.
|
|
- Participate in discussions and help resolve some `issues`.
|
|
- Help maintain the documentation.
|
|
|
|
:::
|