From baf406e7e271ac90faa3aec31ceb44715331d9d0 Mon Sep 17 00:00:00 2001 From: clddup <105873086+clddup@users.noreply.github.com> Date: 星期五, 19 七月 2024 16:47:21 +0800 Subject: [PATCH] chore: 格式化代码 (#3972) --- README.md | 82 +++++++++++++++++++++++------------------ 1 files changed, 46 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index f3c7e5b..25cf715 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,24 @@ ## Introduction -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. +Vue Vben Admin is a free and open source middle platform/back-end template. Using the latest `vue3`, `vite4`, `TypeScript` and other mainstream technology, Vben is the out-of-the-box front-end solution for both production and learning purpose. -## Feature +## Features -- **State of The Art Development**锛歎se front-end front-end technology development such as Vue3/vite2 +- **State-of-art Techinical Stack**锛歎sing the latest and popular front-end technology such as Vue3/vite2 - **TypeScript**: Application-level JavaScript language - **Theming**: Configurable themes -- **International**锛欱uilt-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 +- **International**锛欱uilt-in i18n support +- **Response Mock**: Built-in response mock ability +- **Authority**: Built-in permission system based on dynamic routes. +- **Component**: Extracted and encapsulated components for various scenarios. -## 棰勮 +## Preview -- [vue-vben-admin](https://vvbin.cn/next/) - 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://vvbin.cn/thin/next/) - Simplified Chinese site -- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site +- [vue-vben-admin](https://vben.vvbin.cn/) - Full version (Chinese) +- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version (github hosted) +- [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - Simplified Version (Chinese) +- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified Version (github hosted) Test account: vben/123456 @@ -44,7 +44,7 @@ ## Documentation -[Document](https://vvbin.cn/doc-next/) +[Document](https://doc.vvbin.cn/) ## Preparation @@ -54,7 +54,7 @@ - [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 +- [Ant-Design-Vue](https://antdv.com/docs/vue/introduce-cn/) - ui basic use - [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax ## Install and use @@ -62,29 +62,47 @@ - Get the project code ```bash -git clone https://github.com/anncwb/vue-vben-admin.git +git clone https://github.com/vbenjs/vue-vben-admin.git ``` -- Installation dependencies +- Install dependencies ```bash cd vue-vben-admin -yarn install +pnpm install ``` - run ```bash -yarn serve +pnpm serve ``` - build ```bash -yarn build +pnpm build ``` + +- docker + +### The dockerFile is located in the project root directory and supports differential deployment + +#### build image + +```bash +docker build -t vue-vben-admin . +``` + +#### Use environment variables to achieve differentiated container deployment. Specify service endpoint by assigning `VG_BASE_URL`. In the following example, `http://localhost:3333` is used as the back-end service address and the container is mapped to port `6666`: + +```bash +docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin +``` + +Then you can navigate to `http://localhost:6666` ## Change Log @@ -97,7 +115,7 @@ ## 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銆� +You are very welcome to join锛乕Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) or submit a Pull Request銆� **Pull Request:** @@ -113,7 +131,7 @@ - `feat` Add new features - `fix` Fix the problem/BUG - - `style` The code style is related and does not affect the running result + - `style` Modify the code style/format that does not affect the feature - `perf` Optimization/performance improvement - `refactor` Refactor - `revert` Undo edit @@ -127,13 +145,10 @@ ## Related warehouse -If these plugins are helpful to you, you can give a star support +If these plugins are helpful to you, you can show support by leaving a star! - [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 - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - Used to quickly generate svg sprite @@ -141,7 +156,7 @@ The `Chrome 80+` browser is recommended for local development -Support modern browsers, not IE +Support modern browsers, doesn't include IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | | :-: | :-: | :-: | :-: | :-: | @@ -149,20 +164,15 @@ ## Maintainer -[@Vben](https://github.com/anncwb) +[@Vben](https://github.com/anncwb) [@Jinmao](https://github.com/jinmao88) -## Donate +## Thanks -If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support! +<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="120"> - +## Star History Chart -<a style="display: block;width: 100px;height: 50px;line-height: 50px; color: #fff;text-align: center; background: #408aed;border-radius: 4px;" href="https://www.paypal.com/paypalme/cvvben">Paypal Me</a> - -## Discord - -- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions) -- [Discord](https://discord.gg/8GuAdwDhj6) +[](https://star-history.com/#vbenjs/vue-vben-admin&Date) ## License -- Gitblit v1.8.0