guigu-oa-admin/README.md

90 lines
3.1 KiB
Markdown
Raw Normal View History

# vue-admin-template
2017-06-26 13:38:24 +08:00
2019-04-19 20:45:57 +08:00
English | [简体中文](./README-zh.md)
2019-04-19 20:41:52 +08:00
2017-09-15 14:02:03 +08:00
> A minimal vue admin template with Element UI & axios & iconfont & permission control & lint
2017-07-04 10:40:52 +08:00
**Live demo:** http://panjiachen.github.io/vue-admin-template
2017-09-15 14:05:43 +08:00
2019-04-19 20:41:52 +08:00
2019-04-19 20:45:57 +08:00
**The current version is `v4.0+` build on `vue-cli`. If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-admin-template/tree/tag/3.11.0), it does not rely on `vue-cli`**
2017-06-26 13:38:24 +08:00
## Build Setup
2019-04-19 20:41:52 +08:00
```bash
2019-04-19 20:41:52 +08:00
# clone the project
2019-04-22 12:42:00 +08:00
git clone https://github.com/PanJiaChen/vue-admin-template.git
2019-04-19 20:41:52 +08:00
# enter the project directory
2019-04-22 12:42:00 +08:00
cd vue-admin-template
2017-07-04 10:40:52 +08:00
2019-04-19 20:41:52 +08:00
# install dependency
2017-06-26 13:38:24 +08:00
npm install
2019-04-19 20:41:52 +08:00
# develop
2017-06-26 13:38:24 +08:00
npm run dev
2019-04-19 20:41:52 +08:00
```
This will automatically open http://localhost:9528
2019-04-19 20:41:52 +08:00
## Build
```bash
# build for test environment
npm run build:stage
# build for production environment
npm run build:prod
```
## Advanced
```bash
# preview the release environment effect
npm run preview
# preview the release environment effect + static resource analysis
npm run preview -- --report
2017-06-26 13:38:24 +08:00
2019-04-19 20:41:52 +08:00
# code format check
npm run lint
2017-06-26 13:38:24 +08:00
2019-04-19 20:41:52 +08:00
# code format check and auto fix
npm run lint -- --fix
2017-06-26 13:38:24 +08:00
```
2019-04-19 20:41:52 +08:00
Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
2017-07-04 15:13:02 +08:00
## Demo
2017-07-04 15:13:02 +08:00
![demo](https://github.com/PanJiaChen/PanJiaChen.github.io/blob/master/images/demo.gif)
2017-09-15 14:02:03 +08:00
2017-10-18 15:28:59 +08:00
## Extra
2018-08-16 11:19:38 +08:00
If you want router permission && generate menu by user roles , you can use this branch [permission-control](https://github.com/PanJiaChen/vue-admin-template/tree/permission-control)
2017-10-18 15:28:59 +08:00
For `typescript` version, you can use [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))
2017-09-15 14:05:43 +08:00
## Related Project
[vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
[electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
2017-09-15 14:05:43 +08:00
[vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template)
2018-10-15 17:23:40 +08:00
## Browsers support
Modern browsers and Internet Explorer 10+.
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / 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 |
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
2017-09-15 14:02:03 +08:00
## License
2018-08-16 11:19:38 +08:00
[MIT](https://github.com/PanJiaChen/vue-admin-template/blob/master/LICENSE) license.
2018-01-02 10:07:55 +08:00
Copyright (c) 2017-present PanJiaChen