|
|
@@ -1,260 +1,168 @@
|
|
|
-<p align="center">
|
|
|
- <a href="https://github.com/anncwb/vue-vben-admin" target="_blank">
|
|
|
- <img alt="VbenAdmin Logo" width="200" src="/anncwb/vue-vben-admin/raw/main/.github/res/imgs/logo.png">
|
|
|
- </a>
|
|
|
-</p>
|
|
|
-<h2 align="center">VUE VBEN ADMIN2.0</h2>
|
|
|
-
|
|
|
-[Chinese](./README.zh-CN.md) | **English**
|
|
|
-
|
|
|
-[CHANGELOG](CHANGELOG.en_US.md)
|
|
|
-
|
|
|
-- [Introduction](#introduction)
|
|
|
-- [GitHub](#github)
|
|
|
- - [Thin](#thin)
|
|
|
-- [Preview](#preview)
|
|
|
-- [Documentation](#documentation)
|
|
|
-- [Preinstallation](#preinstallation)
|
|
|
- - [Environmental requirements](#environmental-requirements)
|
|
|
- - [UI framework](#ui-framework)
|
|
|
- - [Icon](#icon)
|
|
|
- - [Plugin](#plugin)
|
|
|
- - [Suggested development environment](#suggested-development-environment)
|
|
|
-- [Install](#install)
|
|
|
-- [Usage](#usage)
|
|
|
- - [Development environment](#development-environment)
|
|
|
- - [Build](#build)
|
|
|
- - [Format](#format)
|
|
|
- - [Other](#other)
|
|
|
-- [Git submit specifications](#git-submit-specifications)
|
|
|
-- [Code contribution](#code-contribution)
|
|
|
-- [Finished features](#finished-features)
|
|
|
-- [Developing features](#developing-features)
|
|
|
-- [Browser support](#browser-support)
|
|
|
-- [Plugins](#plugins)
|
|
|
+<div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br>
|
|
|
|
|
|
-## Introduction
|
|
|
+[](LICENSE)
|
|
|
|
|
|
-The project is based on the vue3 style background management system implemented by ʻant-design-vue`, `typescript`,`vue3.0`,`vite`,`tsx`,
|
|
|
+<h1>Vue vben admin</h1>
|
|
|
+</div>
|
|
|
|
|
|
-## GitHub
|
|
|
+**English** | [中文](./README.zh-CN.md)
|
|
|
|
|
|
-[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` branch
|
|
|
+## Introduction
|
|
|
|
|
|
-### Thin
|
|
|
+Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite2`, `TypeScript` and other mainstream technology development, the out-of-the-box middle and back-end front-end solutions can also be used for learning reference.
|
|
|
|
|
|
-[vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next)
|
|
|
+## Feature
|
|
|
|
|
|
-## Preview
|
|
|
+- **State of The Art Development**：Use front-end front-end technology development such as Vue3/vite2
|
|
|
+- **TypeScript**: Application-level JavaScript language
|
|
|
+- **Theming**: Configurable themes
|
|
|
+- **International**：Built-in complete internationalization program
|
|
|
+- **Mock Server** Built-in mock data scheme
|
|
|
+- **Authority** Built-in complete dynamic routing permission generation scheme.
|
|
|
+- **Component** Multiple commonly used components are encapsulated twice
|
|
|
|
|
|
-- [2.0 preview](https://vvbin.cn/next/)
|
|
|
+## 预览
|
|
|
|
|
|
-- [2.0 Thin Preview](https://vvbin.cn/thin/next/)
|
|
|
+- [vue-vben-admin](https://vvbin.cn/next/) - Full version Chinese site
|
|
|
+- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version of the github site
|
|
|
+- [vben-admin-thin-next](https://vvbin.cn/thin/next/) - Simplified Chinese site
|
|
|
+- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site
|
|
|
|
|
|
-Account for test: vben/123456
|
|
|
+Test account: vben/123456
|
|
|
|
|
|
<p align="center">
|
|
|
- <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png">
|
|
|
- <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png">
|
|
|
- <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png">
|
|
|
+ <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png">
|
|
|
+ <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png">
|
|
|
+ <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png">
|
|
|
</p>
|
|
|
|
|
|
-## Documentation
|
|
|
-
|
|
|
-The documentation for 2.0 hasn't started yet, it will be provided later.
|
|
|
-
|
|
|
-## Preinstallation
|
|
|
-
|
|
|
-### Environmental requirements
|
|
|
-
|
|
|
-- `Node.js`: - Version > `12.0.0` .
|
|
|
-- `yarn` : - Package management tool.
|
|
|
-
|
|
|
-### UI framework
|
|
|
+### Use Gitpod
|
|
|
|
|
|
-- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 has deleted.
|
|
|
-- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/)
|
|
|
+Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
|
|
|
|
|
|
-### Icon
|
|
|
+[](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin)
|
|
|
|
|
|
-- [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - Icon which is imported on demand.
|
|
|
-- [Iconify](https://iconify.design) - Icon can be used [Icônes](https://icones.netlify.app/)
|
|
|
-- [PurgeIcons](https://github.com/antfu/purge-icons) - Icon which is used by build.
|
|
|
+## Documentation
|
|
|
|
|
|
-### Plugin
|
|
|
+[Document](https://vvbin.cn/doc-next/)
|
|
|
|
|
|
-- [Vue Router Next](https://github.com/vuejs/vue-router-next)
|
|
|
-- [Vuex Next](https://github.com/vuejs/vuex)
|
|
|
-- [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - vuex modular
|
|
|
-- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Mock plugin base on vite
|
|
|
-- [vue-i18n](https://github.com/intlify/vue-i18n-next) - Internationalization
|
|
|
-- [lodash-es](https://github.com/lodash/lodash) - JavaScript utility library
|
|
|
-- [axios](https://github.com/axios/axios) - Http data interaction
|
|
|
-- [TypeScript](https://www.typescriptlang.org/)
|
|
|
+## Preparation
|
|
|
|
|
|
-### Suggested development environment
|
|
|
+- [node](http://nodejs.org/) and [git](https://git-scm.com/) - Project development environment
|
|
|
+- [Vite](https://vitejs.dev/) - Familiar with vite features
|
|
|
+- [Vue3](https://v3.vuejs.org/) - Familiar with Vue basic syntax
|
|
|
+- [TypeScript](https://www.typescriptlang.org/) - Familiar with the basic syntax of `TypeScript`
|
|
|
+- [Es6+](http://es6.ruanyifeng.com/) - Familiar with es6 basic syntax
|
|
|
+- [Vue-Router-Next](https://next.router.vuejs.org/) - Familiar with the basic use of vue-router
|
|
|
+- [Ant-Design-Vue](https://2x.antdv.com/docs/vue/introduce-cn/) - ui basic use
|
|
|
+- [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax
|
|
|
|
|
|
-- `Git`: - Tool of version management
|
|
|
-- `Visual Studio Code` - (VSCode): Latest version
|
|
|
- - [VS Code Extensions](./.vscode/extensions.json)
|
|
|
- - [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify)
|
|
|
- - [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind css style association
|
|
|
- - [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - Essential for vue development
|
|
|
- - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Checking script code
|
|
|
- - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code formatting
|
|
|
- - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - Css formatting
|
|
|
+## Install and use
|
|
|
|
|
|
-## Install
|
|
|
+- Get the project code
|
|
|
|
|
|
```bash
|
|
|
-# Make git case sensitive to file names
|
|
|
-git config core.ignorecase false
|
|
|
+git clone https://github.com/anncwb/vue-vben-admin.git
|
|
|
+```
|
|
|
|
|
|
-# Pull code of the project
|
|
|
-git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0
|
|
|
+- Installation dependencies
|
|
|
|
|
|
-cd vue-vben-admin-2.0
|
|
|
+```bash
|
|
|
+cd vue-vben-admin
|
|
|
|
|
|
-# If you use other package management tool, you can install it by yourself
|
|
|
-# if you hasn't install yarn, please run: npm install -g yarn
|
|
|
yarn install
|
|
|
|
|
|
```
|
|
|
|
|
|
-## Usage
|
|
|
-
|
|
|
-### Development environment
|
|
|
+- run
|
|
|
|
|
|
```bash
|
|
|
yarn serve
|
|
|
```
|
|
|
|
|
|
-### Build
|
|
|
+- build
|
|
|
|
|
|
```bash
|
|
|
-
|
|
|
-yarn build # build
|
|
|
-
|
|
|
-yarn build:no-cache # build, cache will be removed before build
|
|
|
-
|
|
|
-yarn report # Generate build package report preview
|
|
|
+yarn build
|
|
|
```
|
|
|
|
|
|
-### Format
|
|
|
-
|
|
|
-```bash
|
|
|
-yarn lint:stylelint # css formatting
|
|
|
+## Change Log
|
|
|
|
|
|
-yarn lint:prettier # js/ts code formatting
|
|
|
-```
|
|
|
+[CHANGELOG](./CHANGELOG.zh_CN.md)
|
|
|
|
|
|
-### Other
|
|
|
+## Project
|
|
|
|
|
|
-```bash
|
|
|
-yarn reinstall # Remove dependencies and reinstall, supported window
|
|
|
+- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - full version
|
|
|
+- [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - Simplified version
|
|
|
|
|
|
-yarn preview # Build and preview in local
|
|
|
+## How to contribute
|
|
|
|
|
|
-yarn log # Generate CHANGELOG
|
|
|
+You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。
|
|
|
|
|
|
-yarn clean:cache # Delete cache
|
|
|
+**Pull Request:**
|
|
|
|
|
|
-yarn clean:lib # Delete node_modules, supported window
|
|
|
-```
|
|
|
+1. Fork code!
|
|
|
+2. Create your own branch: `git checkout -b feat/xxxx`
|
|
|
+3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
|
|
|
+4. Push your branch: `git push origin feat/xxxx`
|
|
|
+5. submit`pull request`
|
|
|
|
|
|
-## Git submit specifications
|
|
|
+## Git Contribution submission specification
|
|
|
|
|
|
-- Refer to [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specifications ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
|
|
|
+- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
|
|
|
|
|
|
- `feat` Add new features
|
|
|
- - `fix` Fix problem/BUG
|
|
|
- - `style` Code style related and doesn't affect the running result
|
|
|
+ - `fix` Fix the problem/BUG
|
|
|
+ - `style` The code style is related and does not affect the running result
|
|
|
- `perf` Optimization/performance improvement
|
|
|
- `refactor` Refactor
|
|
|
- `revert` Undo edit
|
|
|
- `test` Test related
|
|
|
- `docs` Documentation/notes
|
|
|
- - `chore` Dependent update/scaffolding configuration modification etc
|
|
|
+ - `chore` Dependency update/scaffolding configuration modification etc.
|
|
|
- `workflow` Workflow improvements
|
|
|
- `ci` Continuous integration
|
|
|
- - `types` Update file of type definition
|
|
|
- - `wip` Developing
|
|
|
+ - `types` Type definition file changes
|
|
|
+ - `wip` In development
|
|
|
|
|
|
-## Code contribution
|
|
|
+## Related warehouse
|
|
|
|
|
|
-1. Fork code!
|
|
|
-2. Create your own branch: `git checkout -b feat/xxxx`
|
|
|
-3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
|
|
|
-4. Push your branch: `git push origin feat/xxxx`
|
|
|
-5. submit`pull request`
|
|
|
+If these plugins are helpful to you, you can give a star support
|
|
|
|
|
|
-## Finished features
|
|
|
-
|
|
|
-- [x] Project construction (based on vite）)
|
|
|
-- [x] Login and exit
|
|
|
-- [x] Menu (can search, drag and drop and menu layout)
|
|
|
-- [x] Multiple tabs/breadcrumbs
|
|
|
-- [x] Permission management base on role
|
|
|
-- [x] Permission management base on background
|
|
|
-- [x] The separation of routing and menu settings
|
|
|
-- [x] Collapsible sidebar
|
|
|
-- [x] Draggable sidebar
|
|
|
-- [x] Multi-tab mode/global control
|
|
|
-- [x] Menu search
|
|
|
-- [x] Page loading
|
|
|
-- [x] Scroll bar component
|
|
|
-- [x] Pop-up window expansion (dragable, full screen, adaptive height)
|
|
|
-- [x] Mock data
|
|
|
-- [x] hook Package
|
|
|
-- [x] Form component
|
|
|
-- [x] Right-click menu
|
|
|
-- [x] Watermark plugin
|
|
|
-- [x] Animation component
|
|
|
-- [x] QR code plugin
|
|
|
-- [x] Internationalization plugin
|
|
|
-- [x] Details component
|
|
|
-- [x] Validation component
|
|
|
-- [x] Tree component
|
|
|
-- [x] Picture preview component
|
|
|
-- [x] Table component
|
|
|
-- [x] Chart library
|
|
|
-- [x] Digital animation
|
|
|
-- [x] First screen loading waiting animation
|
|
|
-- [x] Extract the production environment profile
|
|
|
-- [x] Build Gzip
|
|
|
-- [x] System performance optimization
|
|
|
-- [x] Data import and export
|
|
|
-- [x] Global error handling
|
|
|
-- [x] Rich text component
|
|
|
-- [x] Upload component
|
|
|
-
|
|
|
-## Developing features
|
|
|
-
|
|
|
-- [ ] Theme configuration
|
|
|
-- [ ] Dark theme
|
|
|
-- [ ] Build CDN
|
|
|
-
|
|
|
-If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue.
|
|
|
+- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Used for local and development environment data mock
|
|
|
+- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - Used for html template conversion and compression
|
|
|
+- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) - Used for component library style introduction on demand
|
|
|
+- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme) - Used to pack compressed image resources
|
|
|
+- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - Used for online switching of theme colors and other color-related configurations
|
|
|
+- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - Used to pack input .gz|.brotil files
|
|
|
|
|
|
## Browser support
|
|
|
|
|
|
-It is recommended to use the `Chrome` browser for local development. Development in the Firefox browser is relatively slow.
|
|
|
+The `Chrome 80+` browser is recommended for local development
|
|
|
|
|
|
-Support modern browsers, Not currently supported ie11，Follow-up consideration support ie11
|
|
|
+Support modern browsers, not 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/)</br>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/)</br>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/)</br>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/)</br>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/)</br>Safari |
|
|
|
| :-: | :-: | :-: | :-: | :-: |
|
|
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
|
|
|
|
|
-More browsers can view [Can I Use Es Module](https://caniuse.com/?search=ES%20Module)
|
|
|
+## Maintainer
|
|
|
+
|
|
|
+[@Vben](https://github.com/anncwb)。
|
|
|
+
|
|
|
+## Donate
|
|
|
+
|
|
|
+If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support!
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+[Paypal Me](https://www.paypal.com/paypalme/cvvben)
|
|
|
+
|
|
|
+## Discord
|
|
|
|
|
|
-## Plugins
|
|
|
+- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions)
|
|
|
+- [Discord](https://discord.gg/8GuAdwDhj6)
|
|
|
|
|
|
-If these plugins are helpful to you, you can give a star
|
|
|
+## License
|
|
|
|
|
|
-- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock)
|
|
|
-- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html)
|
|
|
-- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import)
|
|
|
-- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme)
|
|
|
-- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin)
|
|
|
-- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression)
|
|
|
+[MIT © Vben-2020](./LICENSE)
|
Vben
