From 08d4e34b778caf6f92f02f038f7230fbfbdea885 Mon Sep 17 00:00:00 2001 From: vben <anncwb@126.com> Date: 星期二, 04 四月 2023 17:13:09 +0800 Subject: [PATCH] chore: config ts-config --- README.md | 279 +++++++++++++++++++++---------------------------------- 1 files changed, 108 insertions(+), 171 deletions(-) diff --git a/README.md b/README.md index a9d8eb0..da318bf 100644 --- a/README.md +++ b/README.md @@ -1,229 +1,166 @@ -<p align="center"> - <a href="https://github.com/anncwb/vue-vben-admin" target="_blank"> - <img alt="VbenAdmin Logo" width="200" src="./docs/imgs/logo.png"> - </a> -</p> -<h2 align="center">VUE VBEN ADMIN</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> -**涓枃** +[](LICENSE) -璇ュ垎鏀负2.0鏂板垎鏀紝浣跨敤vue3杩涜寮�鍙戙�� +<h1>Vue vben admin</h1> +</div> -1.0鍒嗘敮璇峰垏鎹㈠埌`master`鍒嗘敮銆�1.0閲囩敤`vue2.6`+`vue-composition-api`+`vue-cli`寮�鍙� +**English** | [涓枃](./README.zh-CN.md) -涓�涓�傚悎寮�鍙戜腑澶у瀷椤圭洰鐨勫熀纭�妗嗘灦锛岄渶瑕佸`vue`,`typescript`鏈変竴瀹氱殑浜嗚В,涔熷彲浠ヤ綔涓轰簡瑙ｆ柊鍐欐硶鐨勪竴涓緥瀛愭潵鐪嬶紝鎻愬墠閫傚簲鍚庣画鏂扮増鏈殑寮�鍙戞柟寮� +## Introduction -椤圭洰鍩轰簬`ant-design-vue`,`typescript`,`vue3.0`,`vite`,`tailwindcss`,`tsx`瀹炵幇鐨� 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. +## Feature -### gitHub 鍦板潃 +- **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 -[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) +## 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 + +Test account: vben/123456 <p align="center"> - <img alt="VbenAdmin Logo" width="100%" src="./build/docs/imgs/preview1.png"> - <img alt="VbenAdmin Logo" width="100%" src="./build/docs/imgs/preview2.png"> - <img alt="VbenAdmin Logo" width="100%" src="./build/docs/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 +[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 -- vue3 -- composition-api: -- vuex4 -- vuex-module-decorators -- vue-router4 -- axios@0.19.2 -- ant-design-vue@2.x -- mockjs -- vue-i18n -- moment -- lodash +## Install and use -[鏇存柊鏃ュ織](CHANGELOG.md) +- Get the project code -- [浣跨敤鍒扮殑鎶�鏈痌(#浣跨敤鍒扮殑鎶�鏈�) -- [鐜瑕佹眰](#鐜瑕佹眰) - - [寤鸿寮�鍙戠幆澧僝(#寤鸿寮�鍙戠幆澧�) -- [瀹夎](#瀹夎) -- [鍛戒护鍙傝��(Terminal)](#鍛戒护鍙傝�僼erminal) - - [鍚姩寮�鍙戠幆澧僝(#鍚姩寮�鍙戠幆澧�) - - [鎵撳寘](#鎵撳寘) - - [鏍煎紡鍖朷(#鏍煎紡鍖�) - - [鍏朵粬](#鍏朵粬) -- [Git 鎻愪氦瑙勮寖](#git-鎻愪氦瑙勮寖) -- [浠ｇ爜璐＄尞](#浠ｇ爜璐＄尞) -- [寮�鍙戣鍒抅(#寮�鍙戣鍒�) -- [鍔犲叆鎴戜滑](#鍔犲叆鎴戜滑) -- - -## 鐜瑕佹眰 - -- `Node.js`: >= v10 -- `yarn`: 鏈�鏂� - -### 寤鸿寮�鍙戠幆澧� - -- `Git`: 鏈�鏂� 浠ｇ爜绠＄悊 -- `Visual Studio Code` (VSCode): 鏈�鏂� IDE - -VSCode 鎻掍欢 - -- `Vetur`: vue 寮�鍙戝繀澶� -- `GitLens`: Git 鍙鍖栧伐鍏� -- `ESLint`: 鑴氭湰浠ｇ爜妫�鏌� -- `stylelint`: 鏍峰紡浠ｇ爜妫�鏌� -- `Prettier - Code formatter`:浠ｇ爜鏍煎紡鍖� - - -## 瀹夎 - -```js -git config core.ignorecase false # 浣縢it瀵规枃浠跺悕澶у皬鍐欐晱鎰� - -// 鎷夊彇椤圭洰浠ｇ爜 - +```bash git clone https://github.com/anncwb/vue-vben-admin.git +``` +- Installation dependencies + +```bash cd vue-vben-admin -// 鏈�濂戒娇鐢▂arn锛屽惁鍒欑儹鏇存柊鍙兘鍑虹幇闂 -yarn install +pnpm install ``` -## 鍛戒护鍙傝��(Terminal) - -### 鍚姩寮�鍙戠幆澧� +- run ```bash -yarn serve +pnpm serve ``` -### 鎵撳寘 - -鍚屾椂浼氱敓鎴愭枃浠跺悕 `window-glob.js` 閰嶇疆鏂囦欢锛岄」鐩厤缃彲浠ュ姩鎬佷慨鏀硅鏂囦欢瀹炴椂鏇存柊浠ｇ爜鍙橀噺锛屾瘮濡傛帴鍙ｅ湴鍧� +- build ```bash - -yarn build # 鎵撳寘 浼氫娇鐢╤ardSource杩涜鎵撳寘 - -yarn build:no-cache # 鎵撳寘 涓嶄細浣跨敤hardSource杩涜鎵撳寘 - -yarn report # 鐢熸垚鏋勫缓鍖呰〃琛ㄩ瑙� +pnpm build ``` +## Change Log -### 鏍煎紡鍖� +[CHANGELOG](./CHANGELOG.zh_CN.md) -```bash -yarn lint:stylelint # 鏍峰紡鏍煎紡鍖� +## Project -yarn lint:prettier # js/ts浠ｇ爜鏍煎紡鍖� -``` +- [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 -```bash -yarn reinstall # 鍒犻櫎渚濊禆閲嶆柊瑁咃紝鍏煎window +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 preview # 鏈湴杩涜鎵撳寘棰勮 +**Pull Request:** -yarn log # 鐢熸垚CHANGELOG -``` +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` -## Git 鎻愪氦瑙勮寖 +## Git Contribution submission specification -- 鍙傝�� [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)) +- 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` 澧炲姞鏂板姛鑳� - - `fix` 淇闂/BUG - - `style` 浠ｇ爜椋庢牸鐩稿叧鏃犲奖鍝嶈繍琛岀粨鏋滅殑 - - `perf` 浼樺寲/鎬ц兘鎻愬崌 - - `refactor` 閲嶆瀯 - - `revert` 鎾ら攢淇敼 - - `test` 娴嬭瘯鐩稿叧 - - `docs` 鏂囨。/娉ㄩ噴 - - `chore` 渚濊禆鏇存柊/鑴氭墜鏋堕厤缃慨鏀圭瓑 - - `workflow` 宸ヤ綔娴佹敼杩� - - `ci` 鎸佺画闆嗘垚 - - `mod` 涓嶇‘瀹氬垎绫荤殑淇敼 - - `wip` 鍒犻櫎鏂囦欢 + - `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 +## Related warehouse -## 浠ｇ爜璐＄尞 +If these plugins are helpful to you, you can give a star support -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` +- [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 +- [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 -- [x] 椤圭洰鎼缓锛堝熀浜� vite锛� -- [x] 鐧诲綍鍜屾敞閿� -- [x] 鑿滃崟锛堝彲浠ユ悳绱㈠強鎷栨嫿浠ュ強鑿滃崟甯冨眬锛� -- [x] 澶氭爣绛鹃〉/闈㈠寘灞� -- [x] 鍩轰簬瑙掕壊鐨勬潈闄愮鐞� -- [x] 鍩轰簬鍚庡彴鐨勬潈闄愮鐞� -- [x] 鍒嗙鐨勮矾鐢卞拰鑿滃崟璁剧疆 -- [x] 鍙姌鍙犱晶杈规爮 -- [x] 鍙嫋鎷戒晶杈规爮 -- [x] 澶氭爣绛鹃〉妯″紡/鍏ㄥ眬鎺у埗 -- [x] 鑿滃崟鎼滅储 -- [x] 椤甸潰鍔犺浇 loading -- [x] 婊氬姩鏉＄粍浠� -- [x] 寮圭獥鎵╁睍锛堝彲鎷栨嫿,鍏ㄥ睆,鑷�傚簲楂樺害锛� -- [x] 鍏ㄥ睆 -- [x] 妯℃嫙鏁版嵁 -- [x] 鍓创鏉垮皝瑁� -- [x] hook 灏佽 -- [x] 椤圭洰鍙厤缃� -- [x] 琛ㄥ崟缁勪欢 -- [x] 鍙抽敭鑿滃崟 -- [x] 姘村嵃鎻掍欢 -- [x] 鍔ㄧ敾缁勪欢 -- [x] 浜岀淮鐮佹彃浠� -- [x] 鍥介檯鍖栨彃浠� -- [x] 璇︽儏缁勪欢 -- [x] 鍥剧墖瑁佸壀 -- [x] 楠岃瘉鐮�/楠岃瘉缁勪欢 -- [x] 鏍戠粍浠� -- [x] 绯荤粺鎬ц兘浼樺寲 -- [x] 鍏煎鏈�鏂癭vuex`,`vue-router` -- [] 鍥剧墖棰勮缁勪欢 -- [ ] 鍥捐〃搴� -- [ ] 鏁板瓧鍔ㄧ敾 -- [ ] 涓婚閰嶇疆 -- [ ] 琛ㄦ牸缁勪欢 -- [ ] 瀵屾枃鏈粍浠� -- [ ] 棣栧睆鍔犺浇绛夊緟鍔ㄧ敾 -- [ ] 涓婁紶缁勪欢 -- [ ] 鍙紪杈戣〃鏍� -- [ ] 鏁版嵁瀵煎叆瀵煎嚭 -- [ ] 鎼缓`vite`鐗堟湰 -- [ ] 鎳掑姞杞界粍浠� -- [ ] 榛戞殫涓婚 -- [ ] 鏇村缁勪欢/鍔熻兘/寤鸿/bug/娆㈣繋鎻愪氦 pr 鎴栬�� issue +| [<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 -`VUE-VBEN-ADMIN` 鏄畬鍏ㄥ紑婧愬厤璐圭殑椤圭洰锛屾棬鍦ㄥ府鍔╁紑鍙戣�呮洿鏂逛究鍦拌繘琛屼腑澶у瀷绠＄悊绯荤粺寮�鍙戯紝鍚屾椂涔熸彁渚� QQ 浜ゆ祦缇�(椤圭洰鍒氳捣姝ワ紝浜烘暟杈冨皯锛屾湁鍏磋叮鐨勫彲浠ュ姞缇や竴璧疯璁�)锛屼娇鐢ㄩ棶棰樻杩庡湪缇ゅ唴鎻愰棶銆� +[@Vben](https://github.com/anncwb) -- QQ 缇� `569291866` +## Donate - <img alt="VbenAdmin Logo" width="100" src="./build/docs/imgs/qq.jpeg"> +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