# orgin-cli

**Repository Path**: lee_Tony/orgin-cli

## Basic Information

- **Project Name**: orgin-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-08-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

##外联平台

###目录结构

>  * **root** 标记为项目初始化配置和公共模块，开发人员不可随意修改，部分内容后期会不断优化新增。新版脚手架更新后，需重新下载，并将已开发的`pages`和`setting`目录下的内容替换到新版脚手架中即可。
>
>  * 由于路由是根据pages下目录结构生成，故pages下的业务文件夹新建需和后台协商，文件夹命名要与菜单接口返回的路由地址一致。路由生成规则参照[umi官网路由指南](https://umijs.org/guide/router.html)
>
>  * 在项目开发时，只需要在`pages`目录下新建文件及修改`setting`目录下的项目配置。
>
>  * 前端模拟的菜单接口在mock中修改，如需新增模拟接口要在`.umirc.mock.js`文件中引入。
>
>  * 接口对接请求，使用`utils/request`中的封装的方法，后期会补上**请求头和加密处理**。
>
>  * `pages`新建文件夹除`umi规则`外，还包括以下约束：
>
>    > * 文件夹名与路由地址保持一致（包括嵌套路由、动态路由）
>    > * 所有主体页面命名为`index.js`，当前页面的`model`和`service`，分别放在同级目录的`models文件夹`和`services文件夹`下。（登录页和404页面除外）
>    > * 当前页面的组件放在`components文件夹`下，组件的文件命名以**大写字母**开头，代码中组件名则需加入`YQ`前缀，用以在代码中区分`antd`提供的组件。
>    > * 样式文件与页面和组件文件名一致，且放在相应同级目录中即可。

```
├─dist                      打包后输出目录
│           
├─mock                      前端模拟接口数据
│              
├─public                    静态资源（字体图标）
│  └─public                 ------（打包后copy至dist）
│      │  logo.svg          ------logo
│      ├─antd               ------存放antd本地字体图标（root）
│      └─orgine             ------存放项目本地字体图标（所有图标文件默认以`iconfont`命名）
│
└─src
│  │  global.js             全局引入（root）
│  │  
│  ├─components	            公共组件（root）
│  │  │  index.js           ------公共组件全局导出（导出变量以YQ为前缀，引用时以区分antd组件）
│  │  │  
│  │  ├─Layout	            ------后台项目结构组件（root）
│  │  │      
│  │  └─Orgine	            ------项目页面公用组件（root）
│  │      │
│  │      ├─Iconfont           ------公共组件示例：（每个组件一个文件夹，首字母大写）
│  │      │    Iconfont.js     ------组件js （首字母大写）
│  │      │    Iconfont.less   ------组件依赖样式（首字母大写）
│  │      │    package.json    ------组件配置参数 （必写）
│  │              
│  ├─layouts                项目结构文件目录（root）
│  │  │  app.js             ------结构组件组合	
│  │  │  app.less	        ------依赖样式	
│  │  │  index.js           ------项目入口
│  │  │  
│  │  ├─models              ------项目结构的model目录
│  │  └─services            ------项目结构的请求目录    
│  │
├─pages   /**页面（路由、业务）目录**/
│  │      
│  ├─demo                   demo页面目录
│  │  │  index.js	        ------demo页面入口
│  │  │  models	        	------demo页model文件夹
│  │  │  services	        ------demo页请求文件夹
│  │  │  
│  │  └─components          ------demo页组件目录
│  │       ModalForm.js	    ------组件文件（大写开头，代码中组件命名以YQ开头，以区分antd组件）
│  │       SearchForm.js
│  │       Table.js
│  │       Tree.js
│  │     
│  ├─overview               总览页目录（登陆后进入的默认页，可在setting/config中修改默认页）
│  │  │  index.js
│  │  │  index.less
│  │  │  models
│  │  │  services
│  │  │  
│  │  └─components          ------总览页组件目录
│  │
│  ├─login  	            登录页目录
│  │  │  index.js
│  │  │  index.less
│  │  │  model.js
│  │  │  service.js     
│  │
│  404.js	                404页面
│  404.less
│  document.ejs             app模板（root）
│  index.js                 app路由重定向包裹（root）      
│  │
├─plugins
│  │   onError.js            全局系统错误处理（root）
│      
├─setting	                 项目配置目录
│  │   config.js		     ------项目配置（接口、路径等）
│  │   constant.js	          ------项目常量	
│  │   routes.js		     ------内页（不在菜单中的页面）路由配置（必写）
│  │   index.js	              ------配置文件导入导出口
│      
├─themes		            公共及默认样式（root） 
│  │   default.less	         ------更改antd样式变量
│  │   index.less	         ------更改antd默认样式
│  │   mixin.less	         ------公共样式变量及函数（less版）
│  │   vars.less
│      
└─utils			            封装工具函数（root） 
│  │   model.js		         ------用于model扩展（公共model）	
│  │   request.js	         ------请求函数封装
│  │   theme.js		         ------公共样式变量（js版）
│  │   index.js		         ------封装函数导入导出口
│  
│  .webpackrc.js             webpack配置文件（开发时本地配置请求代理，文件不上传）
│  .umirc.mock.js            新增模拟的mock数据接口需在该文件中新增引入
│  { * }.{ * }               其他配置文件（root）

```