Commit d68f5b09b2734647a9f8b72853d92014b4148540
1 parent
f2c17542
docs: readme
Showing
1 changed file
with
5 additions
and
180 deletions
README.md
| 1 | -<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> | 1 | +# 系统 |
| 2 | 2 | ||
| 3 | -[](LICENSE) | 3 | +vue-admin-vben |
| 4 | 4 | ||
| 5 | -<h1>Vue vben admin</h1> | ||
| 6 | -</div> | 5 | +# 前端部署地址 |
| 7 | 6 | ||
| 8 | -**English** | [中文](./README.zh-CN.md) | 7 | +39: /home/web/qingdao-order-erp/dist |
| 9 | 8 | ||
| 10 | -## Introduction | ||
| 11 | - | ||
| 12 | -Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite4`, `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. | ||
| 13 | - | ||
| 14 | -## Feature | ||
| 15 | - | ||
| 16 | -- **State of The Art Development**：Use front-end front-end technology development such as Vue3/vite2 | ||
| 17 | -- **TypeScript**: Application-level JavaScript language | ||
| 18 | -- **Theming**: Configurable themes | ||
| 19 | -- **International**：Built-in complete internationalization program | ||
| 20 | -- **Mock Server** Built-in mock data scheme | ||
| 21 | -- **Authority** Built-in complete dynamic routing permission generation scheme. | ||
| 22 | -- **Component** Multiple commonly used components are encapsulated twice | ||
| 23 | - | ||
| 24 | -## Preview | ||
| 25 | - | ||
| 26 | -- [vue-vben-admin](https://vben.vvbin.cn/) - Full version Chinese site | ||
| 27 | -- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version of the github site | ||
| 28 | -- [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - Simplified Chinese site | ||
| 29 | -- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site | ||
| 30 | - | ||
| 31 | -Test account: vben/123456 | ||
| 32 | - | ||
| 33 | -<p align="center"> | ||
| 34 | - <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png"> | ||
| 35 | - <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png"> | ||
| 36 | - <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png"> | ||
| 37 | -</p> | ||
| 38 | - | ||
| 39 | -### Use Gitpod | ||
| 40 | - | ||
| 41 | -Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately. | ||
| 42 | - | ||
| 43 | -[](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) | ||
| 44 | - | ||
| 45 | -## Documentation | ||
| 46 | - | ||
| 47 | -[Document](https://doc.vvbin.cn/) | ||
| 48 | - | ||
| 49 | -## Preparation | ||
| 50 | - | ||
| 51 | -- [node](http://nodejs.org/) and [git](https://git-scm.com/) - Project development environment | ||
| 52 | -- [Vite](https://vitejs.dev/) - Familiar with vite features | ||
| 53 | -- [Vue3](https://v3.vuejs.org/) - Familiar with Vue basic syntax | ||
| 54 | -- [TypeScript](https://www.typescriptlang.org/) - Familiar with the basic syntax of `TypeScript` | ||
| 55 | -- [Es6+](http://es6.ruanyifeng.com/) - Familiar with es6 basic syntax | ||
| 56 | -- [Vue-Router-Next](https://next.router.vuejs.org/) - Familiar with the basic use of vue-router | ||
| 57 | -- [Ant-Design-Vue](https://antdv.com/docs/vue/introduce-cn/) - ui basic use | ||
| 58 | -- [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax | ||
| 59 | - | ||
| 60 | -## Install and use | ||
| 61 | - | ||
| 62 | -- Get the project code | ||
| 63 | - | ||
| 64 | -```bash | ||
| 65 | -git clone https://github.com/anncwb/vue-vben-admin.git | ||
| 66 | -``` | ||
| 67 | - | ||
| 68 | -- Installation dependencies | ||
| 69 | - | ||
| 70 | -```bash | ||
| 71 | -cd vue-vben-admin | ||
| 72 | - | ||
| 73 | -pnpm install | ||
| 74 | - | ||
| 75 | -``` | ||
| 76 | - | ||
| 77 | -- run | ||
| 78 | - | ||
| 79 | -```bash | ||
| 80 | -pnpm serve | ||
| 81 | -``` | ||
| 82 | - | ||
| 83 | -- build | ||
| 84 | - | ||
| 85 | -```bash | ||
| 86 | -pnpm build | ||
| 87 | -``` | ||
| 88 | - | ||
| 89 | -- docker | ||
| 90 | - | ||
| 91 | -### The dockerFile is located in the project root directory and supports differential deployment | ||
| 92 | - | ||
| 93 | -#### build image | ||
| 94 | - | ||
| 95 | -```bash | ||
| 96 | -docker build -t vue-vben-admin . | ||
| 97 | -``` | ||
| 98 | - | ||
| 99 | -#### Environment variables are dynamically used to achieve differentiated container deployment. Different VG_BASE_URL environment variables point to different back-end service addresses. In the following example, http://localhost:3333 is used as the back-end service address and the container is mapped to port 6666 | ||
| 100 | - | ||
| 101 | -```bash | ||
| 102 | -docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin | ||
| 103 | -``` | ||
| 104 | - | ||
| 105 | -Then you can navigate http://localhost:6666 | ||
| 106 | - | ||
| 107 | -## Change Log | ||
| 108 | - | ||
| 109 | -[CHANGELOG](./CHANGELOG.zh_CN.md) | ||
| 110 | - | ||
| 111 | -## Project | ||
| 112 | - | ||
| 113 | -- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - full version | ||
| 114 | -- [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - Simplified version | ||
| 115 | - | ||
| 116 | -## How to contribute | ||
| 117 | - | ||
| 118 | -You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。 | ||
| 119 | - | ||
| 120 | -**Pull Request:** | ||
| 121 | - | ||
| 122 | -1. Fork code! | ||
| 123 | -2. Create your own branch: `git checkout -b feat/xxxx` | ||
| 124 | -3. Submit your changes: `git commit -am 'feat(function): add xxxxx'` | ||
| 125 | -4. Push your branch: `git push origin feat/xxxx` | ||
| 126 | -5. submit`pull request` | ||
| 127 | - | ||
| 128 | -## Git Contribution submission specification | ||
| 129 | - | ||
| 130 | -- 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)) | ||
| 131 | - | ||
| 132 | - - `feat` Add new features | ||
| 133 | - - `fix` Fix the problem/BUG | ||
| 134 | - - `style` The code style is related and does not affect the running result | ||
| 135 | - - `perf` Optimization/performance improvement | ||
| 136 | - - `refactor` Refactor | ||
| 137 | - - `revert` Undo edit | ||
| 138 | - - `test` Test related | ||
| 139 | - - `docs` Documentation/notes | ||
| 140 | - - `chore` Dependency update/scaffolding configuration modification etc. | ||
| 141 | - - `workflow` Workflow improvements | ||
| 142 | - - `ci` Continuous integration | ||
| 143 | - - `types` Type definition file changes | ||
| 144 | - - `wip` In development | ||
| 145 | - | ||
| 146 | -## Related warehouse | ||
| 147 | - | ||
| 148 | -If these plugins are helpful to you, you can give a star support | ||
| 149 | - | ||
| 150 | -- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Used for local and development environment data mock | ||
| 151 | -- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - Used for html template conversion and compression | ||
| 152 | -- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - Used to pack input .gz|.brotil files | ||
| 153 | -- [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - Used to quickly generate svg sprite | ||
| 154 | - | ||
| 155 | -## Browser support | ||
| 156 | - | ||
| 157 | -The `Chrome 80+` browser is recommended for local development | ||
| 158 | - | ||
| 159 | -Support modern browsers, not IE | ||
| 160 | - | ||
| 161 | -| [<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 | | ||
| 162 | -| :-: | :-: | :-: | :-: | :-: | | ||
| 163 | -| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | | ||
| 164 | - | ||
| 165 | -## Maintainer | ||
| 166 | - | ||
| 167 | -[@Vben](https://github.com/anncwb) | ||
| 168 | - | ||
| 169 | -## Donate | ||
| 170 | - | ||
| 171 | -If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support! | ||
| 172 | - | ||
| 173 | - | ||
| 174 | - | ||
| 175 | -<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> | ||
| 176 | - | ||
| 177 | -## Discord | ||
| 178 | - | ||
| 179 | -- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions) | ||
| 180 | -- [Discord](https://discord.gg/8GuAdwDhj6) | ||
| 181 | - | ||
| 182 | -## License | ||
| 183 | - | ||
| 184 | -[MIT © Vben-2020](./LICENSE) | 9 | +47: /order-erp/dist |