# subApp

**Repository Path**: xiawang1024/subApp

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# subapp

## Project setup

``` 
yarn install
```

### Compiles and hot-reloads for development

``` 
yarn serve
```

### Compiles and minifies for production

``` 
yarn build
```

### Lints and fixes files

``` 
yarn lint
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).

## 项目结构

 > 为了代码结构及代码风格的统一，请务必改动标有‘勿动’的文件及文件夹

``` shell
subApp
├─.browserslistrc
├─.editorconfig  #代码风格统一配置文件（勿动）
├─.env.development  #开发环境环境变量配置相关
├─.env.production  #生产环境环境变量配置相关
├─.env.staging  #预发布（测试）环境环境变量配置相关
├─.eslintignore  #eslint 忽略配置
├─.eslintrc.js  #eslint 代码校验配置文件（勿动）
├─.gitignore  #git忽略配置
├─.prettierrc.js  #prettier代码格式化配置（勿动）
├─README.md
├─babel.config.js  #babel配置
├─package.json
├─postcss.config.js #postcss配置
├─vue.config.js  #vue项目配置
├─yarn.lock
├─src
|  ├─App.vue
|  ├─main.js
|  ├─public-path.js  #配合qiankun微前端使用（勿动）
|  ├─views  #视图目录（凡在路由配置里的，都放在此目录下）
|  |   ├─About.vue
|  |   ├─Home.vue
|  |   ├─List.vue
|  |   ├─permission
|  |   |     ├─a.vue
|  |   |     └b.vue
|  |   ├─error
|  |   |   └404.vue
|  ├─utils  #通用工具类目录
|  |   ├─store.js  #浏览器本地存储相关（所有与浏览器存储相关的全部放置在这里面）
|  |   ├─request.js  #axios二次封装
|  |   └validate.js  #一些简单校验
|  ├─styles  #样式表目录
|  |   ├─index.scss  #入口
|  |   ├─mixin.scss  #混入
|  |   ├─sidebar.scss  #侧边栏菜单样式
|  |   ├─transition.scss  #简单过渡
|  |   └variables.scss  #全局样式变量（建议多用变量，全部都放在此文件里）
|  ├─store  #状态管理
|  |   ├─getters.js
|  |   ├─index.js  #入口（会自动加载modules下面的所有模块）
|  |   ├─modules #按模块进行拆分（命名随意，建议按功能模块命名，会自动被加载）
|  |   |    └app.js
|  ├─shared
|  |   └index.js  #主应用子应用通信相关
|  ├─router  #路由目录
|  |   ├─README.md
|  |   ├─common.js  #公共路由集合
|  |   ├─guard.js  #全局路由卫士
|  |   ├─index.js  #入口（会自动加载modules下面的所有子路由模块）
|  |   ├─modules  #按模块进行路由拆分（建议按模块命名，会自动被加载）
|  |   |    ├─404.js
|  |   |    ├─a.js
|  |   |    ├─b.js
|  |   |    └模块路由.md
|  ├─layout  #全局布局目录
|  |   ├─index.vue  #入口
|  |   ├─components
|  |   |     ├─AppMain.vue
|  |   |     ├─index.js
|  |   |     ├─Sidebar
|  |   |     |    ├─Item.vue
|  |   |     |    ├─Link.vue
|  |   |     |    ├─Logo.vue
|  |   |     |    ├─SidebarItem.vue
|  |   |     |    └index.vue
|  ├─icons  #svg图标
|  |   ├─index.js  #入口（自动加载svg目录下的svg文件）
|  |   ├─svgo.yml
|  |   ├─svg
|  |   |  ├─dashboard.svg
|  |   |  ├─example.svg
|  |   |  ├─eye-open.svg
|  |   |  ├─eye.svg
|  |   |  ├─form.svg
|  |   |  ├─link.svg
|  |   |  ├─nested.svg
|  |   |  ├─password.svg
|  |   |  ├─table.svg
|  |   |  ├─tree.svg
|  |   |  └user.svg
|  ├─directive  #自定义指令
|  |     ├─README.md
|  |     ├─index.js  #入口（自动加载modules下面的所有模块）
|  |     ├─modules  #按功能类型进行模块拆分
|  |     |    └permission.js
|  ├─components  #公共组件目录（一个组件，一个文件夹）
|  |     ├─SvgIcon
|  |     |    └index.vue
|  ├─assets
|  |   └logo.png
|  ├─api  #全局api（按模块拆分，按需引入）
|  |  └auth.js
├─public  #public
|   ├─favicon.ico
|   └index.html #入口html
```

## 开发注意事项

* 不用position:fixed定位
* subApp token 数据流： localStorage -> store -> request
* subApp 权限表数据流向：暂定 mainApp -> subApp -> store （开发环境已屏蔽权限： `src/store/modules/app.js` -> `updateRoles` 方法）
* TODO: 更多

## 仓库使用小建议

  > 原仓库（以下均称：基础代码仓库），所有基于基础代码仓库开发的项目，应在基础代码仓库更新后，及时merge到自己的仓库

1. 在自己的仓库里，执行

``` shell
git remote add upstream <gitUrl>

gitUrl: 基础代码仓库地址
```

2. 抓取基础代码仓库更新

``` shell
git featch upstream
```

3. 合并基础代码仓库远程master分支到自己的仓库

``` shell
git merge upstream/master
```