From 908a2fbb3a27d2796a79ccd5576ca4c3a2d372ea Mon Sep 17 00:00:00 2001 From: JinMao <jinmao88@qq.com> Date: 星期二, 15 十一月 2022 19:43:20 +0800 Subject: [PATCH] chore: update ci --- README.md | 305 +++++++++++++++++++------------------------------- 1 files changed, 116 insertions(+), 189 deletions(-) diff --git a/README.md b/README.md index dabebc6..99875c4 100644 --- a/README.md +++ b/README.md @@ -1,242 +1,169 @@ -<p align="center"> - <a href="https://github.com/anncwb/vue-vben-admin" target="_blank"> - <img alt="VbenAdmin Logo" width="200" src="./.github/res/imgs/logo.png"> - </a> -</p> -<h2 align="center">VUE VBEN ADMIN2.0</h2> +<div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br> -**涓枃** | [English](./README-ES.md) +[](LICENSE) -[鏇存柊鏃ュ織](CHANGELOG.md) +<h1>Vue vben admin</h1> +</div> -- [浠嬬粛](#浠嬬粛) -- [gitHub 鍦板潃](#github-鍦板潃) -- [棰勮鍦板潃](#棰勮鍦板潃) -- [鏂囨。](#鏂囨。) -- [棰勫畨瑁匽(#棰勫畨瑁�) - - [鐜瑕佹眰](#鐜瑕佹眰) - - [UI 妗嗘灦](#ui-妗嗘灦) - - [鍥炬爣](#鍥炬爣) - - [鎻掍欢](#鎻掍欢) - - [寤鸿寮�鍙戠幆澧僝(#寤鸿寮�鍙戠幆澧�) -- [瀹夎](#瀹夎) -- [浣跨敤](#浣跨敤) - - [寮�鍙戠幆澧僝(#寮�鍙戠幆澧�) - - [鎵撳寘](#鎵撳寘) - - [鏍煎紡鍖朷(#鏍煎紡鍖�) - - [鍏朵粬](#鍏朵粬) -- [Git 鎻愪氦瑙勮寖](#git-鎻愪氦瑙勮寖) -- [浠ｇ爜璐＄尞](#浠ｇ爜璐＄尞) -- [宸插畬鎴愬姛鑳絔(#宸插畬鎴愬姛鑳�) -- [姝ｅ湪寮�鍙戠殑鍔熻兘](#姝ｅ湪寮�鍙戠殑鍔熻兘) -- [鍔犲叆鎴戜滑](#鍔犲叆鎴戜滑) +**English** | [涓枃](./README.zh-CN.md) -## 浠嬬粛 +## Introduction -璇ュ垎鏀负 2.0 鏂板垎鏀紝浣跨敤 vue3 杩涜寮�鍙戙�� +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. -1.0 鍒嗘敮璇峰垏鎹㈠埌`master`鍒嗘敮銆�1.0 閲囩敤`vue2.6`+`vue-composition-api`+`vue-cli`寮�鍙� +## Feature -椤圭洰鍩轰簬`ant-design-vue`,`typescript`,`vue3.0`,`vite`,`tailwindcss`,`tsx`瀹炵幇鐨� vue3 椋庢牸鐨勫悗鍙扮鐞嗙郴缁燂紝 +- **State of The Art Development**锛歎se front-end front-end technology development 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 -## gitHub 鍦板潃 +## Preview -[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` 鍒嗘敮 +- [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 -## 棰勮鍦板潃 - -[2.0 鍦ㄧ嚎棰勮](https://vvbin.cn/next/) - -娴嬭瘯璐﹀彿: vben/123456 +Test account: vben/123456 <p align="center"> - <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png"> - <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png"> - <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png"> + <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png"> + <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png"> + <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png"> </p> -## 鏂囨。 +### Use Gitpod -2.0 鏂囨。杩樻病寮�濮嬪啓銆傚悗缁ˉ涓娿�� +Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately. -## 棰勫畨瑁� +[](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) -### 鐜瑕佹眰 +## Documentation -- `Node.js`: - 鐗堟湰鏈�濂藉ぇ浜� `12.0.0` -- `yarn` > `npm` > `cnpm`: - 鍖呯鐞嗗伐鍏�. +[Document](https://doc.vvbin.cn/) -### UI 妗嗘灦 +## Preparation -- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 宸插垹闄� -- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/) +- [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 -### 鍥炬爣 +## Install and use -- [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) - 浠呮墦鍖呮墍浣跨敤鍒扮殑鍥炬爣. - -### 鎻掍欢 - -- [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 瀹炵敤绋嬪簭搴� -- [moment](https://github.com/moment/moment) - 鏃堕棿鎿嶄綔搴� -- [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 -// 浣縢it瀵规枃浠跺悕澶у皬鍐欐晱鎰� -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 - -// 濡傛灉浣跨敤鍒殑鍖呯鐞嗗伐鍏凤紝鍙互鑷瀹夎 -// 濡傛灉鏈畨瑁厃arn锛岃杩愯锛歯pm install -g yarn -yarn install - -``` - -## 浣跨敤 - -### 寮�鍙戠幆澧� +- Get the project code ```bash -yarn serve +git clone https://github.com/anncwb/vue-vben-admin.git ``` -### 鎵撳寘 +- Installation dependencies ```bash +cd vue-vben-admin -yarn build # 鎵撳寘 +pnpm install -yarn build:no-cache # 鎵撳寘锛屾墽琛屼箣鍓嶄細鍏堝垹闄ょ紦瀛� - -yarn report # 鐢熸垚鏋勫缓鍖呮姤琛ㄩ瑙� ``` -### 鏍煎紡鍖� +- run ```bash -yarn lint:stylelint # 鏍峰紡鏍煎紡鍖� - -yarn lint:prettier # js/ts浠ｇ爜鏍煎紡鍖� +pnpm serve ``` -### 鍏朵粬 +- build ```bash -yarn reinstall # 鍒犻櫎渚濊禆閲嶆柊瑁咃紝鍏煎window - -yarn preview # 鏈湴杩涜鎵撳寘棰勮 - -yarn log # 鐢熸垚CHANGELOG - -yarn clean:cache # 鍒犻櫎缂撳瓨 - -yarn clean:lib # 鍒犻櫎node_modules锛屽吋瀹箇indow绯荤粺 +pnpm build ``` -## Git 鎻愪氦瑙勮寖 +## Change Log -- 鍙傝�� [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)) +[CHANGELOG](./CHANGELOG.zh_CN.md) - - `feat` 澧炲姞鏂板姛鑳� - - `fix` 淇闂/BUG - - `style` 浠ｇ爜椋庢牸鐩稿叧鏃犲奖鍝嶈繍琛岀粨鏋滅殑 - - `perf` 浼樺寲/鎬ц兘鎻愬崌 - - `refactor` 閲嶆瀯 - - `revert` 鎾ら攢淇敼 - - `test` 娴嬭瘯鐩稿叧 - - `docs` 鏂囨。/娉ㄩ噴 - - `chore` 渚濊禆鏇存柊/鑴氭墜鏋堕厤缃慨鏀圭瓑 - - `workflow` 宸ヤ綔娴佹敼杩� - - `ci` 鎸佺画闆嗘垚 - - `types` 绫诲瀷瀹氫箟鏂囦欢鏇存敼 - - `wip` 寮�鍙戜腑 +## 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 -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` +## 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銆� -- [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] 鍥捐〃搴� +**Pull Request:** -## 姝ｅ湪寮�鍙戠殑鍔熻兘 +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. submit`pull request` -- [ ] 鏁板瓧鍔ㄧ敾 -- [ ] 涓婚閰嶇疆 -- [ ] 瀵屾枃鏈粍浠� -- [ ] 棣栧睆鍔犺浇绛夊緟鍔ㄧ敾 -- [ ] 涓婁紶缁勪欢 -- [ ] 鏁版嵁瀵煎叆瀵煎嚭 -- [ ] 榛戞殫涓婚 -- [ ] 鍏ㄥ眬閿欒澶勭悊 -- [ ] 鎵撳寘 Gzip -- [ ] 鎶藉彇鐢熶骇鐜閰嶇疆鏂囦欢 -- [ ] 绯荤粺鎬ц兘浼樺寲 +## Git Contribution submission specification -鏇村缁勪欢/鍔熻兘/寤鸿/bug/娆㈣繋鎻愪氦 pr 鎴栬�� issue +- 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)) -## 鍔犲叆鎴戜滑 + - `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 -`Vue-Vben-Aadmin` 鏄畬鍏ㄥ紑婧愬厤璐圭殑椤圭洰锛屽湪甯姪寮�鍙戣�呮洿鏂逛究鍦拌繘琛屼腑澶у瀷绠＄悊绯荤粺寮�鍙戯紝鍚屾椂涔熸彁渚� QQ 浜ゆ祦缇�(椤圭洰鍒氳捣姝ワ紝浜烘暟杈冨皯锛屾湁鍏磋叮鐨勫彲浠ュ姞缇や竴璧疯璁�)锛屼娇鐢ㄩ棶棰樻杩庡湪缇ゅ唴鎻愰棶銆� +## Related warehouse -- QQ 缇� `569291866` +If these plugins are helpful to you, you can give a star support - <img alt="VbenAdmin Logo" width="100" src="./.github/res/imgs/qq.jpeg"> +- [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 for online switching of theme colors and other color-related configurations +- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - Used to pack compressed image resources +- [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 + +## Browser support + +The `Chrome 80+` browser is recommended for local development + +Support modern browsers, not 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 | +| :-: | :-: | :-: | :-: | :-: | +| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | + +## Maintainer + +[@Vben](https://github.com/anncwb) + +## Donate + +If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support! + + + +<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) + +## License + +[MIT 漏 Vben-2020](./LICENSE) -- Gitblit v1.8.0