vue-vben-admin

VUE VBEN ADMIN2.0

[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) ## Introduction The project is based on the vue3 style background management system implemented by ʻant-design-vue`, `typescript`,`vue3.0`,`vite`,`tsx`, ## GitHub [vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` branch ### Thin [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) ## Preview - [2.0 preview](https://vvbin.cn/next/) - [2.0 Thin Preview](https://vvbin.cn/thin/next/) Account for test: vben/123456

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

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

Icon

• Ant Design Vue Icon Component - Icon which is imported on demand.
• Iconify - Icon can be used Icônes
• PurgeIcons - Icon which is used by build.

Plugin

• Vue Router Next
• Vuex Next
• vuex-module-decorators - vuex modular
• vite-plugin-mock - Mock plugin base on vite
• vue-i18n - Internationalization
• lodash-es - JavaScript utility library
• axios - Http data interaction
• TypeScript

Suggested development environment

• Git: - Tool of version management
• Visual Studio Code - (VSCode): Latest version
  • VS Code Extensions
  • Iconify IntelliSense
  • Tailwind CSS IntelliSense - Tailwind css style association
  • Vetur - Essential for vue development
  • ESLint - Checking script code
  • Prettier - Code formatting
  • Stylelint - Css formatting

Install

#  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

cd vue-vben-admin-2.0

# 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

yarn serve

Build

yarn build # build

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

yarn report # Generate build package report preview

Format

yarn lint:stylelint # css formatting

yarn lint:prettier # js/ts code formatting

Other

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

Git submit specifications

• 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

Code contribution

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

Finished features

• 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

Developing features

• Theme configuration
• Dark theme
• Build CDN

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

Browser support

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

IEEdgeFirefox 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

Plugins

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

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