1
- # base on Vite2.x + Vue3.x + TypeScript H5 Low code platform
1
+ # 基于 Vite2.x + Vue3.x + TypeScript H5 低代码平台
2
2
3
3
[ ![ license] ( https://img.shields.io/github/license/buqiyuan/vite-vue3-lowcode.svg )] ( LICENSE )
4
4
5
- ** English ** | [ 中文 ] ( ./README.zh-CN .md )
5
+ ** 中文 ** | [ English ] ( ./README.EN .md )
6
6
7
- ## Clone the main branch and ignore irrelevant branches such as git-pages
7
+ ## 克隆主分支,忽略 git-pages 等无关分支
8
8
9
9
``` shell
10
10
git clone --single-branch https://github.com/buqiyuan/vite-vue3-lowcode.git
11
11
# or
12
12
git clone --single-branch https://gitee.com/buqiyuan/vite-vue3-lowcode.git
13
13
```
14
14
15
- ## technology stack
16
-
17
- - Programming Language :[ TypeScript 4.x] ( https://www.typescriptlang.org/zh/ ) + [ JavaScript] ( https://www.javascript.com/ )
18
- - Build Tools :[ Vite 2.x] ( https://cn.vitejs.dev/ )
19
- - Front End Frame :[ Vue 3.x] ( https://v3.cn.vuejs.org/ )
20
- - Subnet Calculator :[ Vue Router 4.x] ( https://next.router.vuejs.org/zh/index.html )
21
- - State Management :[ Vuex 4.x] ( https://next.vuex.vuejs.org/ )
22
- - PC UI Frame :[ Element Plus] ( https://element-plus.org/#/zh-CN )
23
- - H5 UI Frame :[ vant] ( https://vant-contrib.gitee.io/vant/v3/#/zh-CN/ )
24
- - CSS Pre :[ Stylus] ( https://stylus-lang.com/ ) / [ Sass] ( https://sass.bootcss.com/documentation ) / [ Less] ( http://lesscss.cn/ )
25
- - HTTP Tool :[ Axios] ( https://axios-http.com/ )
15
+ ## 技术栈
16
+
17
+ - 编程语言 :[ TypeScript 4.x] ( https://www.typescriptlang.org/zh/ ) + [ JavaScript] ( https://www.javascript.com/ )
18
+ - 构建工具 :[ Vite 2.x] ( https://cn.vitejs.dev/ )
19
+ - 前端框架 :[ Vue 3.x] ( https://v3.cn.vuejs.org/ )
20
+ - 路由工具 :[ Vue Router 4.x] ( https://next.router.vuejs.org/zh/index.html )
21
+ - 状态管理 :[ Vuex 4.x] ( https://next.vuex.vuejs.org/ )
22
+ - PC 端 UI 框架 :[ Element Plus] ( https://element-plus.org/#/zh-CN )
23
+ - H5 端 UI 框架 :[ vant] ( https://vant-contrib.gitee.io/vant/v3/#/zh-CN/ )
24
+ - CSS 预编译 :[ Stylus] ( https://stylus-lang.com/ ) / [ Sass] ( https://sass.bootcss.com/documentation ) / [ Less] ( http://lesscss.cn/ )
25
+ - HTTP 工具 :[ Axios] ( https://axios-http.com/ )
26
26
- Git Hook 工具:[ husky] ( https://typicode.github.io/husky/#/ ) + [ lint-staged] ( https://github.com/okonet/lint-staged )
27
- - Coding Standards :[ EditorConfig] ( http://editorconfig.org ) + [ Prettier] ( https://prettier.io/ ) + [ ESLint] ( https://eslint.org/ ) + [ Airbnb JavaScript Style Guide] ( https://github.com/airbnb/javascript#translation )
28
- - Submit Specifications :[ Commitizen] ( http://commitizen.github.io/cz-cli/ ) + [ Commitlint] ( https://commitlint.js.org/#/ )
29
- - Unit Testing :[ vue-test-utils] ( https://next.vue-test-utils.vuejs.org/ ) + [ jest] ( https://jestjs.io/ ) + [ vue-jest] ( https://github.com/vuejs/vue-jest ) + [ ts-jest] ( https://kulshekhar.github.io/ts-jest/ )
30
- - Auto Deploy :[ GitHub Actions] ( https://docs.github.com/cn/actions/learn-github-actions )
27
+ - 代码规范 :[ EditorConfig] ( http://editorconfig.org ) + [ Prettier] ( https://prettier.io/ ) + [ ESLint] ( https://eslint.org/ ) + [ Airbnb JavaScript Style Guide] ( https://github.com/airbnb/javascript#translation )
28
+ - 提交规范 :[ Commitizen] ( http://commitizen.github.io/cz-cli/ ) + [ Commitlint] ( https://commitlint.js.org/#/ )
29
+ - 单元测试 :[ vue-test-utils] ( https://next.vue-test-utils.vuejs.org/ ) + [ jest] ( https://jestjs.io/ ) + [ vue-jest] ( https://github.com/vuejs/vue-jest ) + [ ts-jest] ( https://kulshekhar.github.io/ts-jest/ )
30
+ - 自动部署 :[ GitHub Actions] ( https://docs.github.com/cn/actions/learn-github-actions )
31
31
32
- ### Function List
32
+ ### 功能清单
33
33
34
- - [x] Add pages dynamically
35
- - [x] Drag and drop components
36
- - [ ] service worker + indexeddb Implement server-free front-end interaction
37
- - [ ] DataSource Admin Console
38
- - [ ] Provide preset functions
39
- - [ ] More component encapsulation
40
- - [ ] Others ...
34
+ - [x] 动态添加页面
35
+ - [x] 拖拽式生成组件
36
+ - [ ] service worker + indexeddb 实现无服务端的前端交互
37
+ - [ ] 数据源管理
38
+ - [ ] 提供预置函数
39
+ - [ ] 更多组件的封装
40
+ - [ ] 其他 ...
41
41
42
- ### Generate component properties quickly
42
+ ### 简易说明
43
+
44
+ 目前在使用表单时,需要把相关的` 表单控件 ` 放到` 表单容器 ` 内部,并且需要将` 按钮 ` 放到` 表单容器 ` 内,
45
+ 然后再讲` 按钮的type ` 设置为` 表单提交按钮 ` 这时候点击提交按钮才会自动收集表单容器内部的所有字段和值
46
+
47
+ ### 快速生成组件属性
43
48
44
49
``` javascript
45
50
// 在vant文档中 chrome控制台输入以下代码,快速生成组件属性
@@ -60,49 +65,50 @@ $$('#props + table tr').reduce((prev, curr) => {
60
65
}, {})
61
66
` ` `
62
67
63
- ## Browser support
68
+ ## 浏览器支持
64
69
65
- The ` Chrome 80 + ` browser is recommended for local development
70
+ 本地开发推荐使用 ` Chrome 80 + ` 浏览器
66
71
67
- Support modern browsers, not IE
72
+ 支持现代浏览器, 不支持 IE
68
73
69
74
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
70
75
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
71
76
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
72
77
73
- ### Git Contribution submission specification
78
+ ### 提交规范
74
79
75
- - ` feat` Add new features
76
- - ` fix` Fix the problem/BUG
77
- - ` style` The code style is related and does not affect the running result
78
- - ` perf` Optimization/performance improvement
79
- - ` refactor` Refactor
80
- - ` revert` Undo edit
81
- - ` test` Test related
82
- - ` docs` Documentation/notes
83
- - ` chore` Dependency update/scaffolding configuration modification etc.
84
- - ` workflow` Workflow improvements
85
- - ` ci` Continuous integration
86
- - ` types` Type definition file changes
87
- - ` wip` In development
80
+ - ` feat` 增加新功能
81
+ - ` fix` 修复问题/BUG
82
+ - ` style` 代码风格相关无影响运行结果的
83
+ - ` perf` 优化/性能提升
84
+ - ` refactor` 重构
85
+ - ` revert` 撤销修改
86
+ - ` test` 测试相关
87
+ - ` docs` 文档/注释
88
+ - ` build` 对构建系统或者外部依赖项进行了修改
89
+ - ` chore` 依赖更新/脚手架配置修改等
90
+ - ` workflow` 工作流改进
91
+ - ` ci` 持续集成
92
+ - ` types` 类型定义文件更改
93
+ - ` wip` 开发中
88
94
89
- ## QUICK START
95
+ ## 快速开始
90
96
91
- ### Install and use
97
+ ### 安装依赖
92
98
93
99
` ` ` sh
94
100
npm install
95
101
# or
96
102
yarn add
97
103
` ` `
98
104
99
- ### run
105
+ ### 启动项目
100
106
101
107
` ` ` sh
102
108
npm run dev
103
109
` ` `
104
110
105
- ### build
111
+ ### 项目打包
106
112
107
113
` ` ` sh
108
114
npm run build
0 commit comments