From fe829aa8e7bc06fadaeb13d163c1753ab9ed9057 Mon Sep 17 00:00:00 2001 From: vben Date: Sun, 28 Jul 2024 17:16:50 +0800 Subject: [PATCH] chore: update README.md --- .gitpod.yml | 2 +- README.md | 61 ++++++-------------- README.zh-CN.md | 35 ++++------- internal/tailwind-config/package.json | 2 +- packages/@core/shared/icons/package.json | 2 +- packages/@core/ui-kit/shadcn-ui/package.json | 2 +- pnpm-lock.yaml | 36 +++++------- 7 files changed, 50 insertions(+), 90 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 9939641c8..2192d9532 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,5 +1,5 @@ ports: - - port: 3344 + - port: 5555 onOpen: open-preview tasks: - init: corepack enable && pnpm install diff --git a/README.md b/README.md index a33ae3e20..a57417005 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
VbenAdmin Logo

+
VbenAdmin Logo

[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE) @@ -11,24 +11,23 @@ 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. +## Upgrade Notice + +This is the latest version, 5.0, and it is not compatible with previous versions. If you are starting a new project, it is recommended to use the latest version. If you wish to view the old version, please use the [v2 branch](https://github.com/vbenjs/vue-vben-admin/tree/v2). + ## Feature -- **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 +- **Latest Technology Stack**: Developed with cutting-edge front-end technologies like Vue 3 and Vite +- **TypeScript**: A language for application-scale JavaScript +- **Themes**: Multiple theme colors available with customizable options +- **Internationalization**: Comprehensive built-in internationalization support +- **Permissions**: Built-in solution for dynamic route-based permission generation ## Preview -- [vue-vben-admin](https://vben.vvbin.cn/) - 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://vben.vvbin.cn/thin/next/) - Simplified Chinese site -- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site +- [Vben Admin](https://vben.pro/) - Full version Chinese site -Test account: vben/123456 +Test Account: vben/123456

VbenAdmin Logo @@ -44,18 +43,7 @@ Open the project in Gitpod (free online dev environment for GitHub) and start co ## Documentation -[Document](https://doc.vvbin.cn/) - -## Preparation - -- [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 +[Document](https://doc.vben.pro/) ## Install and use @@ -70,6 +58,8 @@ git clone https://github.com/anncwb/vue-vben-admin.git ```bash cd vue-vben-admin +corepack enable + pnpm install ``` @@ -77,7 +67,7 @@ pnpm install - run ```bash -pnpm serve +pnpm dev ``` - build @@ -90,11 +80,6 @@ pnpm build [CHANGELOG](./CHANGELOG.zh_CN.md) -## Project - -- [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 - ## How to contribute You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。 @@ -120,19 +105,10 @@ You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vb - `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 -## Related warehouse - -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-compression](https://github.com/anncwb/vite-plugin-compression) - Used to pack input .gz|.brotil files - ## Browser support The `Chrome 80+` browser is recommended for local development @@ -151,7 +127,7 @@ Support modern browsers, not IE 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) +![donate](https://unpkg.com/@vbenjs/static-source@0.1.5/source/sponsor.png) Paypal Me @@ -163,8 +139,7 @@ If you think this project is helpful to you, you can help the author buy a cup o ## Discord -- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions) -- [Discord](https://discord.gg/8GuAdwDhj6) +- [Github Discussions](https://github.com/anncwb/vue-vben-admin/discussions) ## License diff --git a/README.zh-CN.md b/README.zh-CN.md index 8dbb210aa..ef062de68 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,4 +1,4 @@ -

VbenAdmin Logo

+
VbenAdmin Logo

[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE) @@ -11,6 +11,10 @@ Vue Vben Admin 是 Vue Vben Admin 的升级版本。作为一个免费开源的中后台模板，它采用了最新的 Vue 3、Vite、TypeScript 等主流技术开发，开箱即用，可用于中后台前端开发，也适合学习参考。 +## 升级提示 + +该版本为最新版本`5.0`, 与其他版本不兼容，如果你是新项目，建议使用最新版本。如果你想查看旧版本，请使用 [v2 分支](https://github.com/vbenjs/vue-vben-admin/tree/v2) + ## 特性 - **最新技术栈**：使用 Vue3/vite 等前端前沿技术开发 @@ -21,10 +25,7 @@ Vue Vben Admin 是 Vue Vben Admin 的升级版本。作为一个免费开源的 ## 预览 -- [vue-vben-admin](https://vben.vvbin.cn/) - 完整版中文站点 -- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - 完整版 github 站点 -- [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - 简化版中文站点 -- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) - 简化版 github 站点 +- [Vben Admin](https://vben.pro/) - 完整版中文站点 测试账号: vben/123456 @@ -42,18 +43,7 @@ Vue Vben Admin 是 Vue Vben Admin 的升级版本。作为一个免费开源的 ## 文档 -[文档地址](https://doc.vvbin.cn/) - -## 准备 - -- [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 基本语法 +[文档地址](https://doc.vben.pro/) ## 安装使用 @@ -68,6 +58,8 @@ git clone https://github.com/anncwb/vue-vben-admin.git ```bash cd vue-vben-admin +corepack enable + pnpm install ``` @@ -109,7 +101,6 @@ pnpm build - `test` 测试相关 - `docs` 文档/注释 - `chore` 依赖更新/脚手架配置修改等 - - `workflow` 工作流改进 - `ci` 持续集成 - `types` 类型定义文件更改 - `wip` 开发中 @@ -132,15 +123,13 @@ pnpm build 如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持! -![donate](https://anncwb.github.io/anncwb/images/sponsor.png) +![donate](https://unpkg.com/@vbenjs/static-source@0.1.5/source/sponsor.png) Paypal Me -## 交流 - -`Vue-vben-Admin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。 +## Discord -- QQ 群 `569291866` +- [Github Discussions](https://github.com/anncwb/vue-vben-admin/discussions) ## License diff --git a/internal/tailwind-config/package.json b/internal/tailwind-config/package.json index 3ff27588c..9db41ff5b 100644 --- a/internal/tailwind-config/package.json +++ b/internal/tailwind-config/package.json @@ -47,7 +47,7 @@ }, "dependencies": { "@iconify/json": "^2.2.231", - "@iconify/tailwind": "^1.1.1", + "@iconify/tailwind": "^1.1.2", "@tailwindcss/nesting": "0.0.0-insiders.565cd3e", "@tailwindcss/typography": "^0.5.13", "autoprefixer": "^10.4.19", diff --git a/packages/@core/shared/icons/package.json b/packages/@core/shared/icons/package.json index c39278828..6126b00cc 100644 --- a/packages/@core/shared/icons/package.json +++ b/packages/@core/shared/icons/package.json @@ -35,7 +35,7 @@ }, "dependencies": { "@iconify/vue": "^4.1.2", - "lucide-vue-next": "^0.416.0", + "lucide-vue-next": "^0.417.0", "vue": "^3.4.34" } } diff --git a/packages/@core/ui-kit/shadcn-ui/package.json b/packages/@core/ui-kit/shadcn-ui/package.json index c6bf7c4ab..97514ad58 100644 --- a/packages/@core/ui-kit/shadcn-ui/package.json +++ b/packages/@core/ui-kit/shadcn-ui/package.json @@ -48,7 +48,7 @@ "@vben-core/typings": "workspace:*", "@vueuse/core": "^10.11.0", "class-variance-authority": "^0.7.0", - "lucide-vue-next": "^0.416.0", + "lucide-vue-next": "^0.417.0", "radix-vue": "^1.9.2", "vue": "^3.4.34" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b3341deda..75f2d33eb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -361,8 +361,8 @@ importers: specifier: ^2.2.231 version: 2.2.231 '@iconify/tailwind': - specifier: ^1.1.1 - version: 1.1.1 + specifier: ^1.1.2 + version: 1.1.2 '@tailwindcss/nesting': specifier: 0.0.0-insiders.565cd3e version: 0.0.0-insiders.565cd3e(postcss@8.4.40) @@ -530,8 +530,8 @@ importers: specifier: ^4.1.2 version: 4.1.2(vue@3.4.34(typescript@5.5.4)) lucide-vue-next: - specifier: ^0.416.0 - version: 0.416.0(vue@3.4.34(typescript@5.5.4)) + specifier: ^0.417.0 + version: 0.417.0(vue@3.4.34(typescript@5.5.4)) vue: specifier: ^3.4.34 version: 3.4.34(typescript@5.5.4) @@ -645,8 +645,8 @@ importers: specifier: ^0.7.0 version: 0.7.0 lucide-vue-next: - specifier: ^0.416.0 - version: 0.416.0(vue@3.4.34(typescript@5.5.4)) + specifier: ^0.417.0 + version: 0.417.0(vue@3.4.34(typescript@5.5.4)) radix-vue: specifier: ^1.9.2 version: 1.9.2(vue@3.4.34(typescript@5.5.4)) @@ -762,9 +762,6 @@ importers: '@vben/types': specifier: workspace:* version: link:../../types - '@vueuse/core': - specifier: ^10.11.0 - version: 10.11.0(vue@3.4.34(typescript@5.5.4)) vue: specifier: ^3.4.34 version: 3.4.34(typescript@5.5.4) @@ -2994,8 +2991,8 @@ packages: '@iconify/json@2.2.231': resolution: {integrity: sha512-+KlOkI3CuwSuG8H3EIeC7f5LTsm73aggoh1GA9Uh4YCl65zvTgYyFwCxJXnR2vVeCoAlO2UtCtjHjNwOWchf4g==} - '@iconify/tailwind@1.1.1': - resolution: {integrity: sha512-4mmA//qjZigv7D4KlqcVSYTqfRIJzyts2/lSCAJfCL0rVMIE76+ifJnaE5jxCo1+nYGBF8FsFo0qFOs+sX4EnA==} + '@iconify/tailwind@1.1.2': + resolution: {integrity: sha512-ZgToKxxd7zF5T9NXPnY9APRF06ZjFF21H/bINzcbKTdeJzLrNLIoVaoePIUbWVQ2HAac5cAYEHPZO8ILSUe3bQ==} '@iconify/types@2.0.0': resolution: {integrity: sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==} @@ -3086,7 +3083,6 @@ packages: '@ls-lint/ls-lint@2.2.3': resolution: {integrity: sha512-ekM12jNm/7O2I/hsRv9HvYkRdfrHpiV1epVuI2NP+eTIcEgdIdKkKCs9KgQydu/8R5YXTov9aHdOgplmCHLupw==} - cpu: [x64, arm64, s390x] os: [darwin, linux, win32] hasBin: true @@ -3723,7 +3719,7 @@ packages: engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: '@typescript-eslint/parser': ^7.0.0 - eslint: ^8.57.0 + eslint: ^8.56.0 typescript: '*' peerDependenciesMeta: typescript: @@ -3770,7 +3766,7 @@ packages: resolution: {integrity: sha512-r+JFlm5NdB+JXc7aWWZ3fKSm1gn0pkswEwIYsrGPdsT2GjsRATAKXiNtp3vgAAO1xZhX8alIOEQnNMl3kbTgJw==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: - eslint: ^9.7.0 + eslint: ^8.56.0 '@typescript-eslint/visitor-keys@7.17.0': resolution: {integrity: sha512-RVGC9UhPOCsfCdI9pU++K4nD7to+jTcMIbXTSOcrLqUEW6gF2pU1UUbYJKc9cvcRSK1UDeMJ7pdMxf4bhMpV/A==} @@ -5246,7 +5242,7 @@ packages: resolution: {integrity: sha512-/UbPA+bYY7nIxcjL3kpcDY3UNdoLHFhyBFzHox2M0ypcUoueTn6woZUUmzzi5et/dXChksasYYFeKE2wshOrhg==} engines: {node: '>=16'} peerDependencies: - eslint: ^9.7.0 + eslint: ^8.56.0 || ^9.0.0-0 eslint-plugin-jsdoc@48.8.3: resolution: {integrity: sha512-AtIvwwW9D17MRkM0Z0y3/xZYaa9mdAvJrkY6fU/HNUwGbmMtHVvK4qRM9CDixGVtfNrQitb8c6zQtdh6cTOvLg==} @@ -5318,7 +5314,7 @@ packages: resolution: {integrity: sha512-n3AKiVpY2/uDcGrS3+QsYDkjPfaOrNrsfQxU9nt5nitd9KuvVXrfAvgCO9DYPSfap+Gqjw9EOrXIsBp5tlHZjA==} engines: {node: '>=18.18'} peerDependencies: - eslint: ^8.57.0 + eslint: '>=8.56.0' eslint-plugin-unused-imports@4.0.1: resolution: {integrity: sha512-rax76s05z64uQgG9YXsWFmXrgjkaK79AvfeAWiSxhPP6RVGxeRaj4+2u+wxxu/mDy2pmJoOy1QTOEALMia2xGQ==} @@ -6486,8 +6482,8 @@ packages: resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} engines: {node: '>=10'} - lucide-vue-next@0.416.0: - resolution: {integrity: sha512-oNjClUpOTRhLGN0UDvtjGAWBJzYj+rJPr3DxR5aXd2eD6tIuEuF7iaofkvT220VGXAVoXKCqmgk826OJ1M6T6A==} + lucide-vue-next@0.417.0: + resolution: {integrity: sha512-uIoSKLovPHcv2QCLJLZMh7XrBvbPvOwWCyldvOKvAF/3Mbez0isAY/j1WlBnO2Nu2FUNQex6eHXbPtou55H23Q==} peerDependencies: vue: ^3.4.34 @@ -11405,7 +11401,7 @@ snapshots: '@iconify/types': 2.0.0 pathe: 1.1.2 - '@iconify/tailwind@1.1.1': + '@iconify/tailwind@1.1.2': dependencies: '@iconify/types': 2.0.0 @@ -15437,7 +15433,7 @@ snapshots: dependencies: yallist: 4.0.0 - lucide-vue-next@0.416.0(vue@3.4.34(typescript@5.5.4)): + lucide-vue-next@0.417.0(vue@3.4.34(typescript@5.5.4)): dependencies: vue: 3.4.34(typescript@5.5.4)