MQL5-Google-Onedrive/boat-house/management/web/README.md
copilot-swe-agent[bot] aaf34679c7 Add boat-house microservices system to project
Co-authored-by: Mouy-leng <199350297+Mouy-leng@users.noreply.github.com>
2026-02-10 06:28:01 +00:00

88 行
无行尾
4.3 KiB
Markdown

# web
> BootHouse web application
## Build Setup
``` bash
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
# build for production with minification
npm run build
# build for production and view the bundle analyzer report
npm run build --report
# run unit tests
npm run unit
# run e2e tests
npm run e2e
# run all tests
npm test
前端编写约定!
为了减少提交冲突,约定各个目录功能如下:
├── build # 构建相关
├── config # 配置文件
│ ├── dev.env.js # 开发环境配置文件
│ ├── index.js #webpack相关
│ ├── prod.env.js #生产环境配置文件,一idcf社区为准不建议修改
│ ├── test.env.js #测试环境配置文件,一idcf社区为准不建议修改
├── mock # 项目mock 模拟数据
├── plop-templates # 基本模板
├── public # 静态资源
│ │── favicon.ico # favicon图标
│ └── index.html # html模板
├── src # 源代码
│ ├── api # 所有请求
│ ├── assets # 主题 字体等静态资源
│ ├── components # 全局公用组件
│ ├── directive # 全局指令
│ ├── filters # 全局 filter
│ ├── icons # 项目所有 svg icons
│ ├── lang # 国际化 language
│ ├── layout # 全局 layout
│ ├── router # 路由
│ │ ├──index.js # 路由配置文件
│ │ ├──modules # 存储各个模块的路由信息
│ ├── store # 全局 store管理
│ ├── styles # 全局样式
│ ├── utils # 全局公用方法
│ ├── vendor # 公用vendor
│ ├── views # views 所有页面
│ ├── App.vue # 入口页面
│ ├── main.js # 入口文件 加载组件 初始化等
│ └── permission.js # 权限管理
├── tests # 测试
├── .env.xxx # 环境变量配置
├── .eslintrc.js # eslint 配置项
├── .babelrc # babel-loader 配置
├── .travis.yml # 自动化CI配置
├── vue.config.js # vue-cli 配置
├── postcss.config.js # postcss 配置
└── package.json # package.json
目录使用备注
1、dev.env.js #开发环境配置文件,在开发终端修改这个文件进行开发,提交前要改回IDCF社区的dev环境配置
2、沿用vue-element-admin做法,新增内容拆成modules。减少对index.js的修改
3、按照业务功能把每个页面放在view下面,如果页面较小,可以将增删改查功能放在一个文件中;如果页面较大,可以拆成多个模块,页面单独使用的模块放在view目录下。
4、所有请求后端的api封装文件放在src\api下面。按照业务模块划分目录存放。业务模块命名要与view下面业务模块一致
5、命名规则
项目命名:全部采用小写方式, 以下划线分隔。 例:my_project_name
目录命名:有复数结构时,要采用复数命名法。例:scripts、styles、images、data_models
组件名:components组件命名使用大驼峰(KebabCase)TodoItem.vue,组件名为多个单词,这样做可以避免跟现有的以及未来的 HTML 元素相冲突,因为所有的 HTML 元素名称都是单个单词的。
页面名:views目录下,页面命名使用连接符(kebab-case)user-info.vue,如果views下的文件件只有一个文件,命名使用index.vue 。
JS文件命名:名使用分隔符线resize-event.js,如果为单个单词,使用小写md5.js
参考:
[vue规范](https://cn.vuejs.org/v2/style-guide/)
[vue-element-admin开源项目](https://github.com/PanJiaChen/vue-element-admin)
```
For a detailed explanation on how things work, check out the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).