Browse Source

docs: README.md

develop
wally 4 years ago
parent
commit
ab0eb05cb4
  1. 2
      .eslintcache
  2. 1
      CHANGELOG.md
  3. 66
      README.md
  4. 2
      package.json
  5. 2
      vue.config.js

2
.eslintcache

@ -1 +1 @@
[{"/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/mock/rich-text.js":"1","/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/utils/request.js":"2"},{"size":1166,"mtime":1624412295740,"results":"3","hashOfConfig":"4"},{"size":1734,"mtime":1624404795201,"results":"5","hashOfConfig":"4"},{"filePath":"6","messages":"7","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"178d5hk",{"filePath":"8","messages":"9","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/mock/rich-text.js",[],"/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/utils/request.js",[]] [{"/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/main.js":"1"},{"size":485,"mtime":1624427196289,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"178d5hk","/mnt/c/Users/Administrator/Documents/coding/ccsens/demo/tall-v3.0-demo/src/main.js",[]]

1
CHANGELOG.md

@ -3,6 +3,7 @@
### 🌟 新功能 ### 🌟 新功能
范围|描述|commitId 范围|描述|commitId
--|--|-- --|--|--
pinch | alloy finger实现图片的pinch放大缩小 | [de01343](https://gitee.com/mongos/uni-cli-template/commits/de01343)
富文本插件 | 富文本插件demo测试 | [ed3d644](https://gitee.com/mongos/uni-cli-template/commits/ed3d644) 富文本插件 | 富文本插件demo测试 | [ed3d644](https://gitee.com/mongos/uni-cli-template/commits/ed3d644)

66
README.md

@ -1,19 +1,73 @@
# tall-mui-cli # tall-mui-cli
## Project setup ## 项目运行
### 安装依赖
```
yarn
```
### 本地环境运行
+ h5
```
yarn dev:h5
```
+ 微信小程序
```
yarn dev:mp-weixin
```
+ app
``` ```
yarn install yarn dev:app-plus
``` ```
### Compiles and hot-reloads for development ### 生产环境构建
+ h5
``` ```
yarn serve yarn build:h5
``` ```
### Compiles and minifies for production + app
``` ```
yarn build yarn build:app-plus
```
+ 微信小程序
```
yarn build:mp-weixin
``` ```
### Customize configuration ### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/). See [Configuration Reference](https://cli.vuejs.org/config/).
## 代码提交
+ 项目设置了commit lint, commit信息验证;运行`yarn cz` 命令依次填写commit信息即可
+ 以及pre-commit钩子执行eslint代码格式检测, 代码格式不符合规则无法提交
```
yarn cz
```
## 技术栈
### UI及工具库
+ uni-app的cli构建版本
+ vuex vue官方状态管理库
+ tailwindcss 公共样式库(注意这个版本不是最新版本, 最新版本安装后报错)
+ uview-ui uni-app组件库
+ alloyfinger 移动端手势库
+ dayjs 时间处理库
+ pwa 处理缓存, 构建离线应用
### 构建相关
+ sass node-sass
+ prettier 自动格式化代码
+ eslint 代码可是校验
+ commitlint git commit信息校验
+ husky lint-staged git钩子处理commit校验及eslint代码检测
+ vue-cli-plugin-mock mock数据

2
package.json

@ -66,11 +66,9 @@
"autoprefixer": "^9", "autoprefixer": "^9",
"core-js": "^3.6.5", "core-js": "^3.6.5",
"dayjs": "^1.10.5", "dayjs": "^1.10.5",
"flyio": "^0.6.2",
"postcss": "^7", "postcss": "^7",
"regenerator-runtime": "^0.12.1", "regenerator-runtime": "^0.12.1",
"register-service-worker": "^1.7.1", "register-service-worker": "^1.7.1",
"right-pad": "^1.0.1",
"tailwindcss": "npm:@tailwindcss/postcss7-compat", "tailwindcss": "npm:@tailwindcss/postcss7-compat",
"uview-ui": "^1.8.4", "uview-ui": "^1.8.4",
"vue": "^2.6.11", "vue": "^2.6.11",

2
vue.config.js

@ -1,5 +1,5 @@
const path = require('path'); const path = require('path');
const CopyWebpackPlugin = require('copy-webpack-plugin'); //最新版本copy-webpack-plugin插件暂不兼容,推荐v5.0.0 const CopyWebpackPlugin = require('copy-webpack-plugin'); // 最新版本copy-webpack-plugin插件暂不兼容,推荐v5.0.0
module.exports = { module.exports = {
lintOnSave: process.env.NODE_ENV !== 'production', lintOnSave: process.env.NODE_ENV !== 'production',

Loading…
Cancel
Save