Browse Source

first commit

chenzhfa 2 years ago
commit
546e1d71c4
1 changed files with 85 additions and 0 deletions
  1. 85 0
      README.md

+ 85 - 0
README.md

@@ -0,0 +1,85 @@
+# 渠道云终端前端工程
+
+## V 2.0
+
+- 配置文件调整到 config/config.js中,包括代理配置
+- 导航配置在 config/router.config.js
+- 所有业务目录迁移到 pages 中(原位置:routes)
+- 根目录import默认路径为:``` @/ ``` 如:
+    ``` js
+        import component from  '@/components/**'; 
+        import utils from '@/utils/utils.js';
+    ```
+- 安装命令尽量采用 yarn:
+    ```bash
+        yarn install 重新安装全部依赖
+        yarn add [-dev] 新增依赖[开发依赖]
+        yarn start 启动服务
+        yarn run build 构建打包
+        yarn run xxx 运行 package.json 中脚本 xxx
+    ```
+
+## 特性
+
+- :gem: **优雅美观**:基于 Ant Design 体系精心设计
+- :triangular_ruler: **常见设计模式**:提炼自中后台应用的典型页面和场景
+- :iphone: **响应式**:针对不同屏幕大小设计
+- :art: **主题**:可配置的主题满足多样化的品牌诉求
+- :globe_with_meridians: **国际化**:内建业界通用的国际化方案
+- :gear: **最佳实践**:良好的工程实践助您持续产出高质量代码
+- :1234: **Mock 数据**:实用的本地数据调试方案
+- :white_check_mark: **UI 测试**:自动化测试保障前端产品质量
+### v2.0 
+- 更快的二次编译速度
+- 更兼容的开发环境
+- 更简洁的依赖管理
+- 生产环境更易调试的 sourcemap
+
+
+## 工程目录
+
+```
+├─ mock
+    ├─ util.js 【获取 url 参数】
+├─ public  【ico 等资源】
+├─ src
+    ├─ assets     【SVG资源】
+    ├─ common     【通用功能】
+    ├─ components 【通用组件】
+    ├─ e2e        【端到端测试】
+    ├─ layouts    【布局】
+    ├─ models     【model 集合】
+        ├─ ModuleName.js
+        ├─ ModuleName.less
+    ├─ pages     【模块单元】
+    ├─ services   【fetch 请求统一配置】
+    ├─ util       【工具方法】
+    ├─ global.js     【入口】
+    ├─ router.js    【路由根配置】
+├─ tests 【测试】
+```
+
+## 使用
+
+工程初始化:
+```bash
+$ git clone git@git.yonyou.com:occ/occ.git
+$ cd cc-portal-shop
+$ yarn install
+$ yarn start         # 访问 http://localhost:8000
+```
+
+【非 npm 可忽略】为了 npm 安装速度更快,建议使用 cnpm 淘宝镜像:
+```bash
+$ npm install -g cnpm --registry=https://registry.npm.taobao.org
+```
+
+工程打包:
+```bash
+$ npm run-script build
+```
+更多信息请参考 [使用文档](http://pro.ant.design/docs/getting-started)。
+
+## 兼容性
+
+现代浏览器及 IE11。