diff --git a/README.md b/README.md index bf0e08be..e6c4c685 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@
-
+
-
+
@@ -46,18 +46,12 @@ It is a magical vue admin based on the newest development stack of vue, built-in
- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 国内用户可访问该地址在线预览
-**This project is positioned as a background integration solution and is not suitable for secondary development as a basic template.**
-
- Base template recommends using: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
- Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
- Typescript: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))
**This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.**
-**Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+**
-
-**Start using `webpack4` from `v3.8.0`. If you still want to continue using `webpack3`, please use this branch [webpack3](https://github.com/PanJiaChen/vue-element-admin/tree/webpack3)**
-
## Preparation
You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](http://es6.ruanyifeng.com/), [vue](https://cn.vuejs.org/index.html), [vuex](https://vuex.vuejs.org/zh-cn/), [vue-router](https://router.vuejs.org/zh-cn/), [axios](https://github.com/axios/axios) and [element-ui](https://github.com/ElemeFE/element), all request data is simulated using [Mock.js](https://github.com/nuysoft/Mock).
@@ -70,6 +64,7 @@ Understanding and learning this knowledge in advance will greatly help the use o
Admin Dashboard Templates made with Vue, React and Angular.
@@ -159,7 +154,7 @@ This will automatically open http://localhost:9527. ```bash # build for test environment -npm run build:sit +npm run build:stage # build for production environment npm run build:prod @@ -168,19 +163,16 @@ npm run build:prod ## Advanced ```bash -# --report to build with bundle size analytics -npm run build:prod --report +# preview the release environment effect +npm run preview -# --generate a bundle size analytics. default: bundle-report.html -npm run build:prod --generate_report +# preview the release environment effect + static resource analysis +npm run preview -- --report -# --preview to start a server in local to preview -npm run build:prod --preview - -# lint code +# code format check npm run lint -# auto fix +# code format check and auto fix npm run lint -- --fix ``` diff --git a/README.zh-CN.md b/README.zh-CN.md index 5dc9f1d7..20d87f99 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,10 +4,10 @@
-
+
-
+
@@ -46,17 +46,11 @@
- [国内访问文档](https://panjiachen.gitee.io/vue-element-admin-site/zh/) 方便没翻墙的用户查看文档
-**本项目的定位是后台集成方案,不适合当基础模板来开发。**
-
- 模板建议使用: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
- Typescript版: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (鸣谢: [@Armour](https://github.com/Armour))
-群主 **[圈子](https://jianshiapp.com/circles/1209)** 楼主会经常分享一些技术相关的东西,或者加入[qq 群](https://github.com/PanJiaChen/vue-element-admin/issues/602)
-
-**注意:该项目使用 element-ui@2.3.0+ 版本,所以最低兼容 vue@2.5.0+**
-
-**从`v3.8.0`开始使用`webpack4`。所以若还想使用`webpack3`开发,请使用该分支[webpack3](https://github.com/PanJiaChen/vue-element-admin/tree/webpack3)**
+群主 **[圈子](https://jianshiapp.com/circles/1209)** 楼主会经常分享一些技术相关的东西,或者加入[qq 群](https://github.com/PanJiaChen/vue-element-admin/issues/602)或者关注[微博](https://weibo.com/u/3423485724?is_all=1)
**该项目不支持低版本浏览器(如 ie),有需求请自行添加 polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
@@ -94,6 +88,7 @@ Become a sponsor and get your logo on our README on GitHub with a link to your s
- 权限验证
- 页面权限
- 指令权限
+ - 权限配置
- 二步登录
- 多环境发布
@@ -106,7 +101,7 @@ Become a sponsor and get your logo on our README on GitHub with a link to your s
- 动态面包屑
- 快捷导航(标签页)
- Svg Sprite 图标
- - 本地mock数据
+ - 本地 mock 数据
- Screenfull全屏
- 自适应收缩侧边栏
@@ -174,7 +169,7 @@ npm run dev
```bash
# 构建测试环境
-npm run build:sit
+npm run build:stage
# 构建生产环境
npm run build:prod
@@ -183,19 +178,16 @@ npm run build:prod
## 其它
```bash
-# --report to build with bundle size analytics
-npm run build:prod
+# 预览发布环境效果
+npm run preview
-# --generate a bundle size analytics. default: bundle-report.html
-npm run build:prod --generate_report
+# 预览发布环境效果 + 静态资源分析
+npm run preview -- --report
-# --preview to start a server in local to preview
-npm run build:prod --preview
-
-# lint code
+# 代码格式检查
npm run lint
-# auto fix
+# 代码格式检查并自动修复
npm run lint -- --fix
```
diff --git a/build/index.js b/build/index.js
index 3b65a792..baf3807a 100644
--- a/build/index.js
+++ b/build/index.js
@@ -5,7 +5,9 @@ const rawArgv = process.argv.slice(2)
const args = rawArgv.join(' ')
if (process.env.npm_config_preview || rawArgv.includes('--preview')) {
- run(`vue-cli-service build ${args} --report`)
+ const report = rawArgv.includes('--report')
+
+ run(`vue-cli-service build ${args}`)
const port = 9526
const publicPath = config.publicPath
@@ -21,13 +23,12 @@ if (process.env.npm_config_preview || rawArgv.includes('--preview')) {
})
)
- app.listen(port, function() {
- console.log(
- chalk.green(`> Preview at http://localhost:${port}${publicPath}`)
- )
- console.log(
- chalk.green(`> Report at http://localhost:${port}${publicPath}/report.html`)
- )
+ app.listen(port, function () {
+ console.log(chalk.green(`> Preview at http://localhost:${port}${publicPath}`))
+ if (report) {
+ console.log(chalk.green(`> Report at http://localhost:${port}${publicPath}/report.html`))
+ }
+
})
} else {
run(`vue-cli-service build ${args}`)