diff --git a/.editorconfig b/.editorconfig index 1ed2d577..dccf841d 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,8 +6,9 @@ end_of_line=lf insert_final_newline=true indent_style=space indent_size=2 +max_line_length = 100 -[*.yml] +[*.{yml,yaml,json}] indent_style = space indent_size = 2 diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md index 413952fb..0f5e1e0a 100644 --- a/.github/ISSUE_TEMPLATE/1-bug.md +++ b/.github/ISSUE_TEMPLATE/1-bug.md @@ -1,39 +1,39 @@ --- name: 🐛 Bug report about: Create a report to help us improve -labels: 🔍 status/open, 🐛 type/bug +title: '' +labels: 'bug: pending triage' +assignees: '' --- -### Subject of the issue +**⚠️ IMPORTANT ⚠️ Please check the following list before proceeding. If you ignore this issue template, your issue will be directly closed.** -Describe your issue here. +- [ ] Read [the docs](https://anncwb.github.io/vue-vben-admin-doc/). +- [ ] Make sure the code is up to date. (Some bugs have been fixed in the latest code) +- [ ] This is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/anncwb/vue-vben-admin/discussions) or join our [Discord](https://discord.gg/8GuAdwDhj6) Chat Server. -### Your environment +### Describe the bug -- **OS**: -- **Packages**: -- **Env**: +A clear and concise description of what the bug is.. -### Steps to reproduce +### Reproduction -Tell us how to reproduce this issue. Please provide a working and simplified example. +Please describe the steps of the problem in detail to ensure that we can restore the correct problem -🎉 BONUS POINTS for creating a [minimal reproduction](https://stackoverflow.com/help/mcve) and uploading it to GitHub. This will get you the fastest support. 🎉 +## System Info -### Expected behaviour - -What should happen? - -### Actual behaviour - -What happens instead? +- Operating System: +- Node version: +- Package manager (npm/yarn/pnpm) and version: diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md index 1ab313cd..cbe41645 100644 --- a/.github/ISSUE_TEMPLATE/2-feature.md +++ b/.github/ISSUE_TEMPLATE/2-feature.md @@ -1,12 +1,16 @@ --- name: 🚀 Feature request about: Suggest an idea for this project -labels: 🔍 status/open, 🦋 type/enhancement +title: '' +labels: '' +assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/3-help.md b/.github/ISSUE_TEMPLATE/3-help.md deleted file mode 100644 index da15edcb..00000000 --- a/.github/ISSUE_TEMPLATE/3-help.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Question 🤔 -about: Usage question or discussion about alex. -labels: 🔍 status/open, 🙋 type/question ---- - - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..b83ccbf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord Chat + url: https://discord.gg/8GuAdwDhj6 + about: Ask questions and discuss with other Vben users in real time. + - name: Questions & Discussions + url: https://github.com/anncwb/vue-vben-admin/discussions + about: Use GitHub discussions for message-board style questions and discussions. diff --git a/.github/res/imgs/logo.png b/.github/res/imgs/logo.png deleted file mode 100644 index 4941d167..00000000 Binary files a/.github/res/imgs/logo.png and /dev/null differ diff --git a/.github/res/imgs/preview1.png b/.github/res/imgs/preview1.png deleted file mode 100644 index b2d712e1..00000000 Binary files a/.github/res/imgs/preview1.png and /dev/null differ diff --git a/.github/res/imgs/preview2.png b/.github/res/imgs/preview2.png deleted file mode 100644 index e79bf300..00000000 Binary files a/.github/res/imgs/preview2.png and /dev/null differ diff --git a/.github/res/imgs/preview3.png b/.github/res/imgs/preview3.png deleted file mode 100644 index 7fbeae2f..00000000 Binary files a/.github/res/imgs/preview3.png and /dev/null differ diff --git a/.github/res/imgs/qq.jpeg b/.github/res/imgs/qq.jpeg deleted file mode 100644 index 1284f1fc..00000000 Binary files a/.github/res/imgs/qq.jpeg and /dev/null differ diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 559bd0a7..b9d07009 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -6,53 +6,53 @@ on: - main jobs: - push-to-ftp: - if: "contains(github.event.head_commit.message, '[deploy]')" - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 + # push-to-ftp: + # if: "contains(github.event.head_commit.message, '[deploy]')" + # runs-on: ubuntu-latest + # steps: + # - name: Checkout + # uses: actions/checkout@v2 - - name: Sed Config Base - shell: bash - run: | - sed -i 's#VITE_PUBLIC_PATH\s*=.*#VITE_PUBLIC_PATH = /next/#g' ./.env.production - sed -i "s#VITE_BUILD_COMPRESS\s*=.*#VITE_BUILD_COMPRESS = 'gzip'#g" ./.env.production - cat ./.env.production + # - name: Sed Config Base + # shell: bash + # run: | + # sed -i 's#VITE_PUBLIC_PATH\s*=.*#VITE_PUBLIC_PATH = /next/#g' ./.env.production + # sed -i "s#VITE_BUILD_COMPRESS\s*=.*#VITE_BUILD_COMPRESS = 'gzip'#g" ./.env.production + # cat ./.env.production - - name: use Node.js 14 - uses: actions/setup-node@v2.1.2 - with: - node-version: '14.x' + # - name: use Node.js 14 + # uses: actions/setup-node@v2.1.2 + # with: + # node-version: '14.x' - - name: Get yarn cache - id: yarn-cache - run: echo "::set-output name=dir::$(yarn cache dir)" + # - name: Get yarn cache + # id: yarn-cache + # run: echo "::set-output name=dir::$(yarn cache dir)" - - name: Cache dependencies - uses: actions/cache@v2 - with: - path: ${{ steps.yarn-cache.outputs.dir }} - key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: | - ${{ runner.os }}-yarn- + # - name: Cache dependencies + # uses: actions/cache@v2 + # with: + # path: ${{ steps.yarn-cache.outputs.dir }} + # key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + # restore-keys: | + # ${{ runner.os }}-yarn- - - name: Build - run: | - yarn install - yarn run build + # - name: Build + # run: | + # yarn install + # yarn run build - - name: Deploy - uses: SamKirkland/FTP-Deploy-Action@2.0.0 - env: - FTP_SERVER: ${{ secrets.FTP_SERVER }} - FTP_USERNAME: ${{ secrets.FTP_USERNAME }} - FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }} - METHOD: sftp - PORT: ${{ secrets.FTP_PORT }} - LOCAL_DIR: dist - REMOTE_DIR: /srv/www/vben-admin - ARGS: --delete --verbose --parallel=80 + # - name: Deploy + # uses: SamKirkland/FTP-Deploy-Action@2.0.0 + # env: + # FTP_SERVER: ${{ secrets.FTP_SERVER }} + # FTP_USERNAME: ${{ secrets.FTP_USERNAME }} + # FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }} + # METHOD: sftp + # PORT: ${{ secrets.FTP_PORT }} + # LOCAL_DIR: dist + # REMOTE_DIR: /srv/www/vben-admin + # ARGS: --delete --verbose --parallel=80 push-to-gh-pages: if: "contains(github.event.head_commit.message, '[deploy]')" diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..21918950 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,6 @@ +ports: + - port: 3344 + onOpen: open-preview +tasks: + - init: yarn + command: yarn dev diff --git a/CHANGELOG.en_US.md b/CHANGELOG.en_US.md index c421fe7f..af9c9335 100644 --- a/CHANGELOG.en_US.md +++ b/CHANGELOG.en_US.md @@ -1,4 +1,4 @@ -## 2.0.1 (2021-03-04) +## 2.0.2 (2021-03-04) ### ✨ Refactor diff --git a/CHANGELOG.zh_CN.md b/CHANGELOG.zh_CN.md index beb537e3..60602fb6 100644 --- a/CHANGELOG.zh_CN.md +++ b/CHANGELOG.zh_CN.md @@ -1,4 +1,4 @@ -## 2.0.1 (2021-03-04) +## 2.0.2 (2021-03-04) ### ✨ Refactor diff --git a/README.md b/README.md index c13d3091..36c335b3 100644 --- a/README.md +++ b/README.md @@ -1,186 +1,105 @@ -
- - - -
-- - - + + +
+### Use Gitpod + +Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) + ## Documentation -The documentation for 2.0 hasn't started yet, it will be provided later. +[Document](https://vvbin.cn/doc-next/) -## Preinstallation +## Preparation -### Environmental requirements +- [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 -- `Node.js`: - Version > `12.0.0` . -- `yarn` : - Package management tool. +## Install and use -### UI framework - -- [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/) - -### 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 +- 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 +## Change Log -```bash -yarn lint:stylelint # css formatting +[CHANGELOG](./CHANGELOG.zh_CN.md) -yarn lint:prettier # js/ts code formatting -``` +## Project -### Other +- [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 -```bash -yarn reinstall # Remove dependencies and reinstall, supported window +## How to contribute -yarn preview # Build and preview in local +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 log # Generate CHANGELOG - -yarn clean:cache # Delete cache - -yarn clean:lib # Delete node_modules, supported window -``` - -## Git submit specifications - -- 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)) - - - `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 +**Pull Request:** 1. Fork code! 2. Create your own branch: `git checkout -b feat/xxxx` @@ -188,73 +107,62 @@ yarn clean:lib # Delete node_modules, supported window 4. Push your branch: `git push origin feat/xxxx` 5. submit`pull request` -## Finished features +## Git Contribution submission specification -- [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 +- 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)) -## Developing features + - `feat` Add new features + - `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` Dependency update/scaffolding configuration modification etc. + - `workflow` Workflow improvements + - `ci` Continuous integration + - `types` Type definition file changes + - `wip` In development -- [ ] Theme configuration -- [ ] Dark theme -- [ ] Build CDN +## Related warehouse -If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue. +If these plugins are helpful to you, you can give a star support + +- [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 | [](http://godban.github.io/browsers-support-badges/)IE | [](http://godban.github.io/browsers-support-badges/)Edge | [](http://godban.github.io/browsers-support-badges/)Firefox | [](http://godban.github.io/browsers-support-badges/)Chrome | [](http://godban.github.io/browsers-support-badges/)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 -## Plugins +[@Vben](https://github.com/anncwb)。 -If these plugins are helpful to you, you can give a star +## Donate -- [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) +If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support! + +![donate](https://anncwb.github.io/anncwb/images/sponsor.png) + +[Paypal Me](https://www.paypal.com/paypalme/cvvben) + +## Discord + +- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions) +- [Discord](https://discord.gg/8GuAdwDhj6) + +## License + +[MIT © Vben-2020](./LICENSE) diff --git a/README.zh-CN.md b/README.zh-CN.md index 27ed9daa..78379d88 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,170 +1,113 @@ -- - - -
-- - - + + +
+### 使用 Gitpod + +在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) + ## 文档 -[文档地址,持续更新中。。,](https://vvbin.cn/doc-next/) +[文档地址](https://vvbin.cn/doc-next/) -## 预安装 +## 准备 -### 环境要求 +- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境 +- [Vite](https://vitejs.dev/) - 熟悉 vite 特性 +- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法 +- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法 +- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法 +- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用 +- [Ant-Design-Vue](https://2x.antdv.com/docs/vue/introduce-cn/) - ui 基本使用 +- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法 -- `Node.js`: - 版本大于 `12.0.0` -- `yarn` : - 包管理工具. +## 安装使用 -### UI 框架 +- 获取项目代码 -- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 已删除 -- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/) +```bash +git clone https://github.com/anncwb/vue-vben-admin.git +``` -### 图标 +- 安装依赖 -- [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - 按需引入所需图标. -- [Iconify](https://iconify.design) - 使用任何图标集中的图标 [Icônes](https://icones.netlify.app/) -- [PurgeIcons](https://github.com/antfu/purge-icons) - 仅打包所使用到的图标. +```bash +cd vue-vben-admin -### 插件 - -- [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 模块化 -- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 基于 vite 的 mock 插件. -- [vue-i18n](https://github.com/intlify/vue-i18n-next) - 国际化 -- [lodash-es](https://github.com/lodash/lodash) - JavaScript 实用程序库 -- [axios](https://github.com/axios/axios) - Http 数据交互 -- [TypeScript](https://www.typescriptlang.org/) - -### 建议开发环境 - -- `Git`: - 版本管理工具 -- `Visual Studio Code` - (VSCode): 最新版本 - - [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 样式联想 - - [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - vue 开发必备 - - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 脚本代码检查 - - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 代码格式化 - - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - css 格式化 - -## 安装 - -```js -// 使git对文件名大小写敏感 -git config core.ignorecase false - -// 拉取项目代码 - -git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0 - -cd vue-vben-admin-2.0 - -// 如果使用别的包管理工具,可以自行安装 -// 如果未安装yarn,请运行:npm install -g yarn yarn install ``` -## 使用 - -### 开发环境 +- 运行 ```bash yarn serve ``` -### 打包 +- 打包 ```bash - -yarn build # 打包 - -yarn build:no-cache # 打包,执行之前会先删除缓存 - -yarn report # 生成构建包报表预览 +yarn build ``` -### 格式化 +## 更新日志 -```bash -yarn lint:stylelint # 样式格式化 +[CHANGELOG](./CHANGELOG.zh_CN.md) -yarn lint:prettier # js/ts代码格式化 -``` +## 项目地址 -### 其他 +- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - 完整版 +- [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - 简化版 -```bash -yarn reinstall # 删除依赖重新装,兼容window +## 如何贡献 -yarn preview # 本地进行打包预览 +非常欢迎你的加入![提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。 -yarn log # 生成CHANGELOG +**Pull Request:** -yarn clean:cache # 删除缓存 +1. Fork 代码! +2. 创建自己的分支: `git checkout -b feat/xxxx` +3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` +4. 推送您的分支: `git push origin feat/xxxx` +5. 提交`pull request` -yarn clean:lib # 删除node_modules,兼容window系统 -``` - -## Git 提交规范 +## Git 贡献提交规范 - 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) @@ -182,90 +125,45 @@ yarn clean:lib # 删除node_modules,兼容window系统 - `types` 类型定义文件更改 - `wip` 开发中 -## 代码贡献 +## 相关仓库 -1. Fork 代码! -2. 创建自己的分支: `git checkout -b feat/xxxx` -3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` -4. 推送您的分支: `git push origin feat/xxxx` -5. 提交`pull request` +如果这些插件对你有帮助,可以给一个 star 支持下 -## 已完成功能 - -- [x] 项目搭建(基于 vite) -- [x] 登录和注销 -- [x] 菜单(可以搜索及拖拽以及菜单布局) -- [x] 多标签页/面包屑 -- [x] 基于角色的权限管理 -- [x] 基于后台的权限管理 -- [x] 分离的路由和菜单设置 -- [x] 可折叠侧边栏 -- [x] 可拖拽侧边栏 -- [x] 多标签页模式/全局控制 -- [x] 菜单搜索 -- [x] 页面加载 loading -- [x] 滚动条组件 -- [x] 弹窗扩展(可拖拽,全屏,自适应高度) -- [x] 模拟数据 -- [x] hook 封装 -- [x] 表单组件 -- [x] 右键菜单 -- [x] 水印插件 -- [x] 动画组件 -- [x] 二维码插件 -- [x] 国际化插件 -- [x] 详情组件 -- [x] 验证组件 -- [x] 树组件 -- [x] 图片预览组件 -- [x] 表格组件 -- [x] 图表库 -- [x] 数字动画 -- [x] 首屏加载等待动画 -- [x] 抽取生产环境配置文件 -- [x] 打包 Gzip -- [x] 数据导入导出 -- [x] 系统性能优化 -- [x] 全局错误处理 -- [x] 富文本组件 -- [x] 上传组件 -- [x] 多语言支持 - -## 正在开发的功能 - -- [ ] 主题配置 -- [ ] 黑暗主题 -- [ ] 打包 CDN - -更多组件/功能/建议/bug/欢迎提交 pr 或者 issue +- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 用于本地及开发环境数据 mock +- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - 用于 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) - 用于打包输入.gz|.brotil 文件 ## 浏览器支持 -本地开发推荐使用`Chrome`浏览器,在火狐浏览器进行开发相对卡顿。 +本地开发推荐使用`Chrome 80+` 浏览器 -支持现代浏览器, IE 暂不支持,后续考虑支持 ie11 +支持现代浏览器, 不支持 IE | [](http://godban.github.io/browsers-support-badges/)IE | [](http://godban.github.io/browsers-support-badges/)Edge | [](http://godban.github.io/browsers-support-badges/)Firefox | [](http://godban.github.io/browsers-support-badges/)Chrome | [](http://godban.github.io/browsers-support-badges/)Safari | | :-: | :-: | :-: | :-: | :-: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | -更多浏览器可以查看 [Can I Use Es Module](https://caniuse.com/?search=ES%20Module) +## 维护者 -## 插件 +[@Vben](https://github.com/anncwb) -如果这些插件对你有帮助,可以给一个 star 支持下 +## 捐赠 -- [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) +如果你觉得这个项目对你有帮助,你可以帮作者买一杯咖啡表示支持! -## 加入我们 +![donate](https://anncwb.github.io/anncwb/images/sponsor.png) -`Vue-Vben-Aadmin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群(项目刚起步,人数较少,有兴趣的可以加群一起讨论),使用问题欢迎在群内提问。 +[Paypal Me](https://www.paypal.com/paypalme/cvvben) + +## 交流 + +`Vue-vben-Admin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群使用问题欢迎在群内提问。 - QQ 群 `569291866` - +## License + +[MIT © Vben-2020](./LICENSE) diff --git a/mock/_createProductionServer.ts b/mock/_createProductionServer.ts index 6ac92ffa..a44310b9 100644 --- a/mock/_createProductionServer.ts +++ b/mock/_createProductionServer.ts @@ -1,6 +1,5 @@ import { createProdMockServer } from 'vite-plugin-mock/es/createProdMockServer'; -// @ts-ignore const modules = import.meta.globEager('./**/*.ts'); const mockModules: any[] = []; diff --git a/package.json b/package.json index e658b6f0..f09ef5bc 100644 --- a/package.json +++ b/package.json @@ -110,7 +110,7 @@ "vite-plugin-pwa": "^0.5.6", "vite-plugin-style-import": "^0.7.6", "vite-plugin-theme": "^0.4.8", - "vite-plugin-windicss": "0.6.4", + "vite-plugin-windicss": "0.6.5", "vue-eslint-parser": "^7.6.0", "yargs": "^16.2.0" }, diff --git a/src/components/Icon/src/IconPicker.vue b/src/components/Icon/src/IconPicker.vue index 181a3fc8..c0a836fc 100644 --- a/src/components/Icon/src/IconPicker.vue +++ b/src/components/Icon/src/IconPicker.vue @@ -91,8 +91,8 @@ const icons = getIcons(); export default defineComponent({ name: 'IconPicker', - inheritAttrs: false, components: { [Input.name]: Input, Icon, Popover, ScrollContainer, Pagination, Empty }, + inheritAttrs: false, props: { value: propTypes.string, width: propTypes.string.def('100%'), diff --git a/src/components/Tree/src/TreeHeader.vue b/src/components/Tree/src/TreeHeader.vue index 9b2e0ef6..f8b9cabe 100644 --- a/src/components/Tree/src/TreeHeader.vue +++ b/src/components/Tree/src/TreeHeader.vue @@ -26,7 +26,7 @@ import type { PropType } from 'vue'; import { defineComponent, ref } from 'vue'; - import { Dropdown, Menu, Checkbox, Input } from 'ant-design-vue'; + import { Dropdown, Menu, Input } from 'ant-design-vue'; import { Icon } from '/@/components/Icon'; import { BasicTitle } from '/@/components/Basic'; @@ -45,7 +45,6 @@ components: { BasicTitle, Icon, - Checkbox, Dropdown, Menu, MenuItem: Menu.Item, diff --git a/yarn.lock b/yarn.lock index 9816b02c..254a6c73 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1780,10 +1780,10 @@ dependencies: vue-demi latest -"@windicss/plugin-utils@0.6.4": - version "0.6.4" - resolved "https://registry.npmjs.org/@windicss/plugin-utils/-/plugin-utils-0.6.4.tgz#854f411b156fea61b2e6724799e91f0f9407a637" - integrity sha512-5RZQ71snmoKmZEXHyCByOohUM/SsWIX856+geMwOfbMOGL0guv/1TVg2PalFrZh3k/HfqQnO2ft5YSWKtrW32A== +"@windicss/plugin-utils@0.6.5": + version "0.6.5" + resolved "https://registry.npmjs.org/@windicss/plugin-utils/-/plugin-utils-0.6.5.tgz#c37082ea3e52c605508e7fb9b7331cb80b140441" + integrity sha512-8ZZdauxS+d3AE7RQtk7R6cWgiHQ/IUvavv0vsfXHKdvEkwMyI/GUU01VLWTXWRsWyM2+D2F6/HOgUxmxYQx5Sg== dependencies: esbuild "^0.8.54" esbuild-register "^2.0.0" @@ -8957,12 +8957,12 @@ vite-plugin-theme@^0.4.8: es-module-lexer "^0.3.26" tinycolor2 "^1.4.2" -vite-plugin-windicss@0.6.4: - version "0.6.4" - resolved "https://registry.npmjs.org/vite-plugin-windicss/-/vite-plugin-windicss-0.6.4.tgz#2d2bc7831dddff129d597959efaff616c6408a01" - integrity sha512-4BuUglBXeNIrIDfSKyg7rvqKEmxvyja2aKJxgHdOCICV8jIz2MvrZaRS9a74gUihz+OohBYqLnkOlfD+sCIQBg== +vite-plugin-windicss@0.6.5: + version "0.6.5" + resolved "https://registry.npmjs.org/vite-plugin-windicss/-/vite-plugin-windicss-0.6.5.tgz#14b6fc43fcbc2dc143b33c83c58e3f7fe820aa9a" + integrity sha512-zEpPlVRaXQbgA0Tsj/N4Kt1jAEZ2aMqVrq4/LaTekS0LCdtD1sQXoadAz2Af/N+qA7ICu8VBpijONH6c8AS4Xg== dependencies: - "@windicss/plugin-utils" "0.6.4" + "@windicss/plugin-utils" "0.6.5" windicss "^2.2.3" vite@^2.0.5: