项目目录规范

5/29/2020

This is 项目目录规范 home.

.
├── vue.config.js               # webpack 配置文件
├── config/                     # 与项目构建相关的常用的配置选项;
│   ├── index.js                # 主配置文件
│   ├── sit.env.js              # sit 环境变量
│   ├── uat.env.js              # uat 环境变量
│   └── prod.env.js             # 生产环境变量
│
├── src/
│   ├── main.js                 # webpack 的入口文件;
│   ├── assets/                 # 共用的代码以外的资源,如:图片、图标、视频 等;
│   ├── api/                    # 网络模块,如:接口;
│   ├── router/                 # 路由模块
│   ├── views/                  # 页面文件
│   ├── vuex/                   # 组件共享状态
│   ├── components/             # 共用的组件;; 这里的存放的组件应该都是展示组件
│   │   ├── base/               # 基本组件,如:共用的弹窗组件,loading加载组件,提示组件。
│   │   ├── common/             # 共用的全局组件,封装的导航条,底部组件等等
│   │   ├── temp/               # 模板组件,如:相同的页面封装成一个组件。
│   │   └── UItemp/             # UI组件,如:项目中特定的按钮,消息数字,等等一些样式可以封装成组件的。
│   ├── common/                 # 共用的资源,如:常用的图片、图标,共用的组件、模块、样式,常量文件等等;
│   │   ├── compatible/         # 兼容模块,如:适合App和微信各种接口的模块;
│   │   ├── extension/          # 已有类的扩展模块,如:对 Array 类型进行扩展的模块;
│   │   ├── libraries/          # 存放自己封装的或者引用的库;
│   │   ├── tools/              # 自己封装的一些工具
│   │   ├── constant.js         # 存放js的常量;
│   │   ├── constant.scss       # 存放scss的常量;
│   │   └── ...
│   └── app/                    # 存放项目业务代码;
│       └── App.vue             # app 的根组件;
├── public/                     # 纯静态资源,该目录下的文件不会被webpack处理,该目录会被拷贝到输出目录下;
├── .babelrc                    # babel 的配置文件
├── .prettierrc.js              # prettier 配置文件;可配置如代码格式;
├── .eslintrc.js                # eslint 的配置文件
├── .eslintignore               # eslint 的忽略规则
├── .gitignore                  # git的忽略配置文件
├── .postcssrc.js               # postcss 的配置文件
├── CHAGNELOG.md                # 版本更新变更release
├── index.html                  # HTML模板
├── package.json                # npm包配置文件,里面定义了项目的npm脚本,依赖包等信息
└── README.md                   # 项目信息文档
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41