Sin descripción

vben b84de1a515 fix: fix npm script hace 4 años
.github 66b5616957 chore: change menu icon hace 4 años
.vscode e8aedefb38 chore: separate configuration files hace 4 años
build b84de1a515 fix: fix npm script hace 4 años
mock faf3f4602e feat(table): add table component hace 4 años
public 4811cce809 feat: first screen loading waiting animation hace 4 años
src b84de1a515 fix: fix npm script hace 4 años
.editorconfig 2f6253cfb6 initial commit hace 4 años
.env 03b6025d07 refactor(style): remove tailwind css hace 4 años
.env.development 8a1bfdf13d feat: auto import route hace 4 años
.env.production 8a1bfdf13d feat: auto import route hace 4 años
.eslintignore 2f6253cfb6 initial commit hace 4 años
.eslintrc.js 2f6253cfb6 initial commit hace 4 años
.gitignore afbcf043fc chore: update readme.md hace 4 años
.ls-lint.yml 2f6253cfb6 initial commit hace 4 años
.prettierignore 2f6253cfb6 initial commit hace 4 años
CHANGELOG.en_US.md 9abba7af3e chore: remove test code hace 4 años
CHANGELOG.zh_CN.md 8a1bfdf13d feat: auto import route hace 4 años
LICENSE 2f6253cfb6 initial commit hace 4 años
README.en-US.md 8a1bfdf13d feat: auto import route hace 4 años
README.md 8a1bfdf13d feat: auto import route hace 4 años
commitlint.config.js ad36886559 chore: add .github and .vscode hace 4 años
index.html bb3b8f817d feat: the production environment can be dynamically configured hace 4 años
lint-staged.config.js 2f6253cfb6 initial commit hace 4 años
package.json b84de1a515 fix: fix npm script hace 4 años
postcss.config.js 77db3d5f80 style: perf code style hace 4 años
prettier.config.js 2f6253cfb6 initial commit hace 4 años
stylelint.config.js 2f6253cfb6 initial commit hace 4 años
tsconfig.json 03b6025d07 refactor(style): remove tailwind css hace 4 años
vite.config.ts 8a1bfdf13d feat: auto import route hace 4 años
yarn.lock 8a1bfdf13d feat: auto import route hace 4 años

README.en-US.md

VbenAdmin Logo

VUE VBEN ADMIN2.0

[Chinese](./README.md) | **English** [CHANGELOG](CHANGELOG.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) ## Introduction This branch is a 2.0 new branch which use vue3 to develop. You can also switch to 1.0 branch which use `vue2.6` , `vue-composition-api` and `vue-cli` to develop. 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

VbenAdmin Logo VbenAdmin Logo VbenAdmin Logo

Documentation

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

Preinstallation

Environmental requirements

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

UI framework

Icon

Plugin

Suggested development environment

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

Developing features

  • Upload component
  • Rich text component
  • Data import and export
  • Global error handling
  • Theme configuration
  • Dark theme
  • Build CDN
  • System performance optimization

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
 Edge
 Edge
Firefox
ChromeChrome SafariSafari not support last 2 versions last 2 versions last 2 versions last 2 versions

More browsers can view Can I Use Es Module