<<<<<<< HEAD 中文 | English

• 介绍
• gitHub 地址
  • 精简版地址
• 预览地址
• 文档
• 预安装
  • 环境要求
  • UI 框架
• 修改清单
• 注意
  • 开发环境
  • 打包
  • 格式化
  • 其他
• Git 提交规范
• 浏览器支持
• 插件
• 加入我们

项目基于ant-design-vue,typescript,vue3.0,vite,tsx实现的 vue3 风格的后台管理系统，

vue-vben-admin2.0 - main 分支

======= Chinese | English

CHANGELOG

• Introduction
• GitHub
  • Thin
• Preview
• Documentation
• Preinstallation
  • Environmental requirements
  • UI framework
  • Icon
  • Plugin
  • Suggested development environment
• Install
• Usage
  • Development environment
  • Build
  • Format
  • Other
• Git submit specifications
• Code contribution
• Finished features
• Developing features
• Browser support
• Plugins

The project is based on the vue3 style background management system implemented by ʻant-design-vue, typescript,vue3.0,vite,tsx`,

vue-vben-admin2.0 - main branch

1fac4b4ba76d432b9a56e142a8d56571e825950f

vue-vben-admin-thin-next

<<<<<<< HEAD

• 2.0 精简版 在线预览

• 2.0 preview

• 2.0 Thin Preview

  1fac4b4ba76d432b9a56e142a8d56571e825950f

Account for test: vben/123456

The documentation for 2.0 hasn't started yet, it will be provided later.

<<<<<<< HEAD

• Node.js: - 版本最好大于 12.0.0

• yarn > npm > cnpm: - 包管理工具.

• Node.js: - Version>12.0.0 is better.
• yarn > npm > cnpm: - Package management tool.

  1fac4b4ba76d432b9a56e142a8d56571e825950f

• Tailwind CSS - 2.0.0-beta.5 has deleted.
• Ant Design Vue 2.0

<<<<<<< HEAD 测试账号: vben/123456

当你开始使用时，请按下面列表先行修改项目

• 重命名 package.json 中的 name 字段
• 在LICENSE中更改作者姓名
• 在public中修改 favicon.ico
• 在public/resource/和/src/assets/images/logo.png中修改 logo.png
• 在.env[xxx]文件中修改相关项目配置
• 在src/settings/projectSetting.ts内调整适合自己的项目风格
• 项目默认启用角色来控制菜单，且后台请求菜单已被注释，如果需要使用后台动态生成路由。
  • 请将/src/store/modules/permission.ts内的关于动态请求菜单的注释放开
  • 请将/src/utils/helper/routeHelper.ts内的关于动态请求菜单的注释放开

依赖删除了echarts,apexcharts,zxcvbn,qrcode,xlsx,vditor。但是组件及代码未删除。在你未引用到相关组件的时候，不会发出错误。当你需要使用的时候，只需要执行相应的命令安装对应模块即可

需要用到哪个则执行对应命令

yarn add echarts

yarn add apexcharts
=======
### Icon

- [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.

### Plugin

- [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/)

### Suggested development environment

- `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

```bash
#  Make git case sensitive to file names
git config core.ignorecase false

# Pull code of the project
git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0
>>>>>>> 1fac4b4ba76d432b9a56e142a8d56571e825950f

yarn add zxcvbn

<<<<<<< HEAD
yarn add qrcode
=======
# 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
>>>>>>> 1fac4b4ba76d432b9a56e142a8d56571e825950f

yarn add vditor

<<<<<<< HEAD
yarn add xlsx

=======

1fac4b4ba76d432b9a56e142a8d56571e825950f

yarn serve

yarn build # build

yarn build:no-cache # build, cache will be removed before build

yarn report # Generate build package report preview

yarn lint:stylelint # css formatting

yarn lint:prettier # js/ts code formatting

yarn reinstall # Remove dependencies and reinstall, supported window

yarn preview # Build and preview in local

yarn log # Generate CHANGELOG

yarn clean:cache # Delete cache

yarn clean:lib # Delete node_modules, supported window

<<<<<<< HEAD

• 参考 vue 规范 (Angular)

  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中

本地开发推荐使用Chrome浏览器,在火狐浏览器进行开发相对卡顿。

• Refer to vue specifications (Angular)

  • feat Add new features
  • fix Fix problem/BUG
  • style Code style related and doesn't 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
  • workflow Workflow improvements
  • ci Continuous integration
  • types Update file of type definition
  • wip Developing

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. submitpull request

• Project construction (based on vite）)
• Login and exit
• Menu (can search, drag and drop and menu layout)
• Multiple tabs/breadcrumbs
• Permission management base on role
• Permission management base on background
• The separation of routing and menu settings
• Collapsible sidebar
• Draggable sidebar
• Multi-tab mode/global control
• Menu search
• Page loading
• Scroll bar component
• Pop-up window expansion (dragable, full screen, adaptive height)
• Mock data
• hook Package
• Form component
• Right-click menu
• Watermark plugin
• Animation component
• QR code plugin
• Internationalization plugin
• Details component
• Validation component
• Tree component
• Picture preview component
• Table component
• Chart library
• Digital animation
• First screen loading waiting animation
• Extract the production environment profile
• Build Gzip
• System performance optimization
• Data import and export
• Global error handling
• Rich text component
• Upload component

• Theme configuration
• Dark theme
• Build CDN

If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue.

It is recommended to use the Chrome browser for local development. Development in the Firefox browser is relatively slow.

Support modern browsers, Not currently supported ie11，Follow-up consideration support ie11

1fac4b4ba76d432b9a56e142a8d56571e825950f

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

More browsers can view Can I Use Es Module

If these plugins are helpful to you, you can give a star

• vite-plugin-mock
• vite-plugin-html
• vite-plugin-style-import