1.0.0 • Published 4 years ago
jyapptestets-2 v1.0.0
JY-UI-H5
鲸鱼培优用户端UI库
项目背景
本项目旨在将C端各个项目中的常用组件做自研及聚合,满足C端各项目定制化需求
项目介绍
packages
项目既是一个NPM依赖包,也是一个前端项目,日常的组件开发主要在packages中进行,具体的项目结构参考已经实现了的组件。README.md是项目启动后可以在页面中查看的说明文档,除了lib、packages、src目录下的index.js,其余文件在npm publish的时候不会被发布,均在.npmignore中已被忽略
logWhale.md
特别注意: 每一次更新packages,发包前必须要有相应的更新日志且要相应的作者信息,时间顺序从上到下依次是从最近到最新,可以参考微信小程序的日志维护格式
router
- nav.data.json主要维护左侧侧边栏的数据,每新增一个组件或者插件,需要在侧边栏进行添加,
- title为侧边栏标题展示,
- path:是readme${组件或插件名},比如:readmeIndicator,
- showPath:组件名,指的是页面右侧手机iframe里的路由名
- index.js 作为前端项目,所有的路由在这里维护
项目启动
npm install
本地开发
npm run dev // 本地开发(同时开启文档部分webpack热更新和rollup热更新)
npm run build:lib // 打包组件
npm run publish // 打包并发布
目录结构说明
├─.babelrc
├─.editorconfig
├─.eslintignore
├─.eslintrc.js
├─.gitignore
├─.npmignore
├─README.md
├─favicon.ico
├─index.html //文档入口文件
├─index.js
├─package-lock.json
├─package.json
├─rollup.config.js //rollup入口文件
├─static
| ├─style
| | ├─base.scss
| | └demoPage.scss
├─src
| └index.js
├─packages //组件源码部分
| ├─toast //组件
| | ├─README.md //组件文档
| | ├─index.js //组件入口
| | ├─src
| | | └toast.vue //组件源码
| | ├─assets //静态资源目录
| | | ├─tips_success.png
| | | ├─warn.png
| | | └wrong.png
├─lib //打包后的组件 部分(umd, 其他规范可在rollup中配置)
| ├─toast
| | ├─index.css
| | ├─index.js
| | ├─index.min.js
| | ├─assets
| | | ├─7580721e.png
| | | ├─a4f313d7.png
| | | └e7054456.png
├─examples // 文档部分(本地开发)
| ├─App.vue
| ├─main.js
| ├─views
| | ├─pages
| | | ├─bottomPopup.vue
| | | ├─button.vue
| | | ├─confirm.vue
| | | ├─indicator.vue
| | | ├─input.vue
| | | └toast.vue
| | ├─logPage
| | | └index.vue
| | ├─installPage
| | | └index.vue
| | ├─index
| | | └index.vue
| | ├─demoPage
| | | └index.vue
| ├─router
| | ├─index.js
| | └nav.data.js
| ├─docs
| | ├─installWhale.md
| | └logWhale.md
| ├─components
| | ├─Summary.vue
| | └TopHeader.vue
| ├─assets
| | ├─logo.png
| | ├─images
| | | ├─logo.jpeg
| | | ├─phone.png
| | | └whaleIcon.png
├─config
| ├─dev.env.js
| ├─index.js
| ├─prod.env.js
| └test.env.js
├─build //webpack rollup
| ├─build.js
| ├─check-versions.js
| ├─getComponentEntries.js
| ├─logo.png
| ├─rollup.config.base.js
| ├─utils.js
| ├─vue-loader.conf.js
| ├─webpack.base.conf.js
| ├─webpack.dev.conf.js
| ├─webpack.prod.conf.js
| ├─md-loader
| | ├─config.js
| | ├─containers.js
| | ├─fence.js
| | ├─index.js
| | └util.js
1.0.0
4 years ago