1.0.8 • Published 2 years ago

assets-module-component v1.0.8

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

RenderBus FE

Usage

Install

yarn install

Development

# package dependencies(once)
yarn build:dll

# start server
yarn dev

Build

# package
yarn build

# deploy to dev.renderbus.com
yarn deploy

# deploy to dev.foxrenderfarm.com
deploy:foreign

Structure

###文件说明

  • ./.eslintrc.js - ESLint 配置文件
  • ./.pug-lintrc.js - PugLint 配置文件
  • ./stylelint.config.js - Style Lint 配置文件
  • ./build/webpack.base.js -Webpack 配置文件(基础配置文件)
  • ./build/webpack.dev.js - Webpack 配置文件 (开发环境)
  • ./build/webpack.prod.js - Webpack 配置文件 (生产环境)
  • ./dist/ - 打包后的代码
  • ./src - 项目源码
  • ./src/index.html - Webpack 打包用模板
  • ./src/assets/ - 资源文件
  • ./src/assets/styles - 全局的 CSS 文件
  • ./src/assets/images - 全局的图片资源
  • ./src/assets/legacies - 旧式的 JS 依赖
  • ./src/app/ - 应用
  • ./src/app/main.js - 应用入口
  • ./src/app/App.vue - 根组件
  • ./src/app/views/ - 视图
  • ./src/app/router/ - 路由
  • ./src/app/vendors/ - 依赖库入口
  • ./src/app/store/ - 状态管理
  • ./src/app/utils/ - 抽象工具
  • ./src/add/api/ - API请求
  • ./src/app/components/ - 自定义公共组件

部分文件说明

优先级高于👆的列表,没特别说明的为常规操作或脚手架生成的文件

├── build
│   ├── build.js
│   ├── check-versions.js
│   ├── dev-client.js
│   ├── dev-server.js
│   ├── preload # 应用首次加载进度条插件,详见注释
│   ├── utils.js
│   ├── vue-loader.conf.js
│   ├── webpack.base.conf.js
│   ├── webpack.dev.conf.js
│   ├── webpack.dll.conf.js # build:dll 命令调用打包依赖模块,用于提升开发时构建速度用
│   ├── webpack.prod.conf.js
│   └── webpack.test.conf.js
├── config
│   ├── dev.env.js
│   ├── index.js
│   ├── prod.env.js
│   └── test.env.js
├── deploy.sh # 部署用 shell 脚本
├── miniprogram # 小程序相关文件
│   └── platform.json # 控制小程序平台翻译
├── src
│   ├── App.vue
│   ├── api
│   │   ├── config.js # 配置 axios 请求头与请求、响应拦截器
│   │   └── default.js # axios 配置相关的一些变量与常量
│   ├── assets
│   ├── components
│   ├── config
│   ├── directives
│   ├── filter
│   ├── i18n
│   ├── main.ts
│   ├── map
│   ├── mixin
│   ├── router
│   ├── sfc.d.ts
│   ├── store
│   ├── utils
│   ├── vendors
│   │   └── typhoon_pb.js # 镭速客户端自动生成的文件,更新需找镭速同事
│   └── views
├── static
│   ├── assets # 废弃
│   ├── img # 文件服务产生的文件图标,打包时由 copy-webpack-plugin 移至发布根目录
│   ├── vendor-manifest.json # build:dll 命令生成文件
│   └── vendor.dll.js # build:dll 命令生成文件
├── tsconfig.json
├── tslint.json
├── typings
│   ├── globals
│   └── index.d.ts
└── success.html # 充值成功后回调页面,打包时由 copy-webpack-plugin 移至发布根目录

Notice

  • 图片、CSS、页面等资源应该放在最小共用的父节点处
  • 不应该滥用全局资源储存位置(./src/assets/),比如只有主页用到的图片不应该放在这个位置,这样会加大查找的难度
  • 修改平台号翻译时,platform.json文件也要修改

eg.

./src/views/mainPage/ 下所有页面共享同一个 CSS 作为模板,那么 page1 不应该放在 ./src/auth/page1/ 里,而是应该放在 ./src/views/mainPage/

Standard

Code Review

Document

Todo

  • 开发模式和生产模式Lint
  • git hook