diff --git a/README.zh-CN.md b/README.EN.md similarity index 63% rename from README.zh-CN.md rename to README.EN.md index b559e57..aefc5d1 100644 --- a/README.zh-CN.md +++ b/README.EN.md @@ -1,10 +1,10 @@ -# 基于 Vite2.x + Vue3.x + TypeScript H5 低代码平台 +# base on Vite2.x + Vue3.x + TypeScript H5 Low code platform [![license](https://img.shields.io/github/license/buqiyuan/vite-vue3-lowcode.svg)](LICENSE) -**中文** | [English](./README.md) +**English** | [中文](./README.md) -## 克隆主分支,忽略 git-pages 等无关分支 +## Clone the main branch and ignore irrelevant branches such as git-pages ```shell git clone --single-branch https://github.com/buqiyuan/vite-vue3-lowcode.git @@ -12,39 +12,34 @@ git clone --single-branch https://github.com/buqiyuan/vite-vue3-lowcode.git git clone --single-branch https://gitee.com/buqiyuan/vite-vue3-lowcode.git ``` -## 技术栈 +## technology stack -- 编程语言:[TypeScript 4.x](https://www.typescriptlang.org/zh/) + [JavaScript](https://www.javascript.com/) -- 构建工具:[Vite 2.x](https://cn.vitejs.dev/) -- 前端框架:[Vue 3.x](https://v3.cn.vuejs.org/) -- 路由工具:[Vue Router 4.x](https://next.router.vuejs.org/zh/index.html) -- 状态管理:[Vuex 4.x](https://next.vuex.vuejs.org/) -- PC 端 UI 框架:[Element Plus](https://element-plus.org/#/zh-CN) -- H5 端 UI 框架:[vant](https://vant-contrib.gitee.io/vant/v3/#/zh-CN/) -- CSS 预编译:[Stylus](https://stylus-lang.com/) / [Sass](https://sass.bootcss.com/documentation) / [Less](http://lesscss.cn/) -- HTTP 工具:[Axios](https://axios-http.com/) +- Programming Language:[TypeScript 4.x](https://www.typescriptlang.org/zh/) + [JavaScript](https://www.javascript.com/) +- Build Tools:[Vite 2.x](https://cn.vitejs.dev/) +- Front End Frame:[Vue 3.x](https://v3.cn.vuejs.org/) +- Subnet Calculator:[Vue Router 4.x](https://next.router.vuejs.org/zh/index.html) +- State Management:[Vuex 4.x](https://next.vuex.vuejs.org/) +- PC UI Frame:[Element Plus](https://element-plus.org/#/zh-CN) +- H5 UI Frame:[vant](https://vant-contrib.gitee.io/vant/v3/#/zh-CN/) +- CSS Pre:[Stylus](https://stylus-lang.com/) / [Sass](https://sass.bootcss.com/documentation) / [Less](http://lesscss.cn/) +- HTTP Tool:[Axios](https://axios-http.com/) - Git Hook 工具:[husky](https://typicode.github.io/husky/#/) + [lint-staged](https://github.com/okonet/lint-staged) -- 代码规范:[EditorConfig](http://editorconfig.org) + [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#translation) -- 提交规范:[Commitizen](http://commitizen.github.io/cz-cli/) + [Commitlint](https://commitlint.js.org/#/) -- 单元测试:[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/) -- 自动部署:[GitHub Actions](https://docs.github.com/cn/actions/learn-github-actions) +- Coding Standards:[EditorConfig](http://editorconfig.org) + [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#translation) +- Submit Specifications:[Commitizen](http://commitizen.github.io/cz-cli/) + [Commitlint](https://commitlint.js.org/#/) +- 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/) +- Auto Deploy:[GitHub Actions](https://docs.github.com/cn/actions/learn-github-actions) -### 功能清单 +### Function List -- [x] 动态添加页面 -- [x] 拖拽式生成组件 -- [ ] service worker + indexeddb 实现无服务端的前端交互 -- [ ] 数据源管理 -- [ ] 提供预置函数 -- [ ] 更多组件的封装 -- [ ] 其他... +- [x] Add pages dynamically +- [x] Drag and drop components +- [ ] service worker + indexeddb Implement server-free front-end interaction +- [ ] DataSource Admin Console +- [ ] Provide preset functions +- [ ] More component encapsulation +- [ ] Others... -### 简易说明 - -目前在使用表单时,需要把相关的`表单控件`放到`表单容器`内部,并且需要将`按钮`放到`表单容器`内, -然后再讲`按钮的type`设置为`表单提交按钮`这时候点击提交按钮才会自动收集表单容器内部的所有字段和值 - -### 快速生成组件属性 +### Generate component properties quickly ```javascript // 在vant文档中 chrome控制台输入以下代码,快速生成组件属性 @@ -65,36 +60,35 @@ $$('#props + table tr').reduce((prev, curr) => { }, {}) ``` -## 浏览器支持 +## Browser support -本地开发推荐使用`Chrome 80+` 浏览器 +The `Chrome 80+` browser is recommended for local development -支持现代浏览器, 不支持 IE +Support modern browsers, not IE | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | -### 提交规范 +### Git Contribution submission specification -- `feat` 增加新功能 -- `fix` 修复问题/BUG -- `style` 代码风格相关无影响运行结果的 -- `perf` 优化/性能提升 -- `refactor` 重构 -- `revert` 撤销修改 -- `test` 测试相关 -- `docs` 文档/注释 -- `build` 对构建系统或者外部依赖项进行了修改 -- `chore` 依赖更新/脚手架配置修改等 -- `workflow` 工作流改进 -- `ci` 持续集成 -- `types` 类型定义文件更改 -- `wip` 开发中 +- `feat` Add new features +- `fix` Fix the problem/BUG +- `style` The code style is related and does not affect the running result +- `perf` Optimization/performance improvement +- `refactor` Refactor +- `revert` Undo edit +- `test` Test related +- `docs` Documentation/notes +- `chore` Dependency update/scaffolding configuration modification etc. +- `workflow` Workflow improvements +- `ci` Continuous integration +- `types` Type definition file changes +- `wip` In development -## 快速开始 +## QUICK START -### 安装依赖 +### Install and use ```sh npm install @@ -102,13 +96,13 @@ npm install yarn add ``` -### 启动项目 +### run ```sh npm run dev ``` -### 项目打包 +### build ```sh npm run build diff --git a/README.md b/README.md index 61d89d3..1d1d01c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# base on Vite2.x + Vue3.x + TypeScript H5 Low code platform +# 基于 Vite2.x + Vue3.x + TypeScript H5 低代码平台 [![license](https://img.shields.io/github/license/buqiyuan/vite-vue3-lowcode.svg)](LICENSE) -**English** | [中文](./README.zh-CN.md) +**中文** | [English](./README.EN.md) -## Clone the main branch and ignore irrelevant branches such as git-pages +## 克隆主分支,忽略 git-pages 等无关分支 ```shell git clone --single-branch https://github.com/buqiyuan/vite-vue3-lowcode.git @@ -12,34 +12,39 @@ git clone --single-branch https://github.com/buqiyuan/vite-vue3-lowcode.git git clone --single-branch https://gitee.com/buqiyuan/vite-vue3-lowcode.git ``` -## technology stack +## 技术栈 -- Programming Language:[TypeScript 4.x](https://www.typescriptlang.org/zh/) + [JavaScript](https://www.javascript.com/) -- Build Tools:[Vite 2.x](https://cn.vitejs.dev/) -- Front End Frame:[Vue 3.x](https://v3.cn.vuejs.org/) -- Subnet Calculator:[Vue Router 4.x](https://next.router.vuejs.org/zh/index.html) -- State Management:[Vuex 4.x](https://next.vuex.vuejs.org/) -- PC UI Frame:[Element Plus](https://element-plus.org/#/zh-CN) -- H5 UI Frame:[vant](https://vant-contrib.gitee.io/vant/v3/#/zh-CN/) -- CSS Pre:[Stylus](https://stylus-lang.com/) / [Sass](https://sass.bootcss.com/documentation) / [Less](http://lesscss.cn/) -- HTTP Tool:[Axios](https://axios-http.com/) +- 编程语言:[TypeScript 4.x](https://www.typescriptlang.org/zh/) + [JavaScript](https://www.javascript.com/) +- 构建工具:[Vite 2.x](https://cn.vitejs.dev/) +- 前端框架:[Vue 3.x](https://v3.cn.vuejs.org/) +- 路由工具:[Vue Router 4.x](https://next.router.vuejs.org/zh/index.html) +- 状态管理:[Vuex 4.x](https://next.vuex.vuejs.org/) +- PC 端 UI 框架:[Element Plus](https://element-plus.org/#/zh-CN) +- H5 端 UI 框架:[vant](https://vant-contrib.gitee.io/vant/v3/#/zh-CN/) +- CSS 预编译:[Stylus](https://stylus-lang.com/) / [Sass](https://sass.bootcss.com/documentation) / [Less](http://lesscss.cn/) +- HTTP 工具:[Axios](https://axios-http.com/) - Git Hook 工具:[husky](https://typicode.github.io/husky/#/) + [lint-staged](https://github.com/okonet/lint-staged) -- Coding Standards:[EditorConfig](http://editorconfig.org) + [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#translation) -- Submit Specifications:[Commitizen](http://commitizen.github.io/cz-cli/) + [Commitlint](https://commitlint.js.org/#/) -- 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/) -- Auto Deploy:[GitHub Actions](https://docs.github.com/cn/actions/learn-github-actions) +- 代码规范:[EditorConfig](http://editorconfig.org) + [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#translation) +- 提交规范:[Commitizen](http://commitizen.github.io/cz-cli/) + [Commitlint](https://commitlint.js.org/#/) +- 单元测试:[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/) +- 自动部署:[GitHub Actions](https://docs.github.com/cn/actions/learn-github-actions) -### Function List +### 功能清单 -- [x] Add pages dynamically -- [x] Drag and drop components -- [ ] service worker + indexeddb Implement server-free front-end interaction -- [ ] DataSource Admin Console -- [ ] Provide preset functions -- [ ] More component encapsulation -- [ ] Others... +- [x] 动态添加页面 +- [x] 拖拽式生成组件 +- [ ] service worker + indexeddb 实现无服务端的前端交互 +- [ ] 数据源管理 +- [ ] 提供预置函数 +- [ ] 更多组件的封装 +- [ ] 其他... -### Generate component properties quickly +### 简易说明 + +目前在使用表单时,需要把相关的`表单控件`放到`表单容器`内部,并且需要将`按钮`放到`表单容器`内, +然后再讲`按钮的type`设置为`表单提交按钮`这时候点击提交按钮才会自动收集表单容器内部的所有字段和值 + +### 快速生成组件属性 ```javascript // 在vant文档中 chrome控制台输入以下代码,快速生成组件属性 @@ -60,35 +65,36 @@ $$('#props + table tr').reduce((prev, curr) => { }, {}) ``` -## Browser support +## 浏览器支持 -The `Chrome 80+` browser is recommended for local development +本地开发推荐使用`Chrome 80+` 浏览器 -Support modern browsers, not IE +支持现代浏览器, 不支持 IE | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | -### Git Contribution submission specification +### 提交规范 -- `feat` Add new features -- `fix` Fix the problem/BUG -- `style` The code style is related and does not affect the running result -- `perf` Optimization/performance improvement -- `refactor` Refactor -- `revert` Undo edit -- `test` Test related -- `docs` Documentation/notes -- `chore` Dependency update/scaffolding configuration modification etc. -- `workflow` Workflow improvements -- `ci` Continuous integration -- `types` Type definition file changes -- `wip` In development +- `feat` 增加新功能 +- `fix` 修复问题/BUG +- `style` 代码风格相关无影响运行结果的 +- `perf` 优化/性能提升 +- `refactor` 重构 +- `revert` 撤销修改 +- `test` 测试相关 +- `docs` 文档/注释 +- `build` 对构建系统或者外部依赖项进行了修改 +- `chore` 依赖更新/脚手架配置修改等 +- `workflow` 工作流改进 +- `ci` 持续集成 +- `types` 类型定义文件更改 +- `wip` 开发中 -## QUICK START +## 快速开始 -### Install and use +### 安装依赖 ```sh npm install @@ -96,13 +102,13 @@ npm install yarn add ``` -### run +### 启动项目 ```sh npm run dev ``` -### build +### 项目打包 ```sh npm run build diff --git a/package.json b/package.json index 7c8bbea..49adfc1 100644 --- a/package.json +++ b/package.json @@ -23,19 +23,20 @@ "@vant/touch-emulator": "^1.3.0", "@vueuse/core": "^5.0.2", "@vueuse/integrations": "^5.0.2", + "animate.css": "^4.1.1", "axios": "^0.21.1", "dayjs": "^1.10.5", "dexie": "^3.0.3", - "element-plus": "^1.0.2-beta.46", + "element-plus": "^1.0.2-beta.48", "lodash": "^4.17.21", - "monaco-editor": "^0.24.0", + "monaco-editor": "^0.25.0", "normalize.css": "^8.0.1", "nprogress": "^1.0.0-1", "qrcode": "^1.4.4", "vant": "^3.0.18", - "vue": "3.0.11", + "vue": "3.1.1", "vue-router": "^4.0.8", - "vuedraggable": "^4.0.1", + "vuedraggable": "^4.0.3", "vuex": "^4.0.1" }, "devDependencies": { @@ -47,7 +48,7 @@ "@vitejs/plugin-legacy": "^1.4.1", "@vitejs/plugin-vue": "^1.2.3", "@vitejs/plugin-vue-jsx": "^1.1.5", - "@vue/compiler-sfc": "3.0.11", + "@vue/compiler-sfc": "3.1.1", "commitizen": "^4.2.4", "cz-conventional-changelog": "^3.3.0", "cz-customizable": "^6.3.0", @@ -55,7 +56,7 @@ "eslint-config-prettier": "^8.3.0", "eslint-plugin-import": "^2.23.4", "eslint-plugin-prettier": "^3.4.0", - "eslint-plugin-vue": "^7.10.0", + "eslint-plugin-vue": "^7.11.0", "gh-pages": "^3.2.0", "husky": "^6.0.0", "lint-staged": "^11.0.0", @@ -68,7 +69,7 @@ "stylelint-order": "^4.1.0", "typescript": "^4.3.2", "vite": "2.3.7", - "vite-plugin-components": "^0.10.4", + "vite-plugin-components": "^0.11.1", "vite-plugin-style-import": "^0.10.1", "vite-plugin-windicss": "^1.0.3", "vue-eslint-parser": "^7.6.0", diff --git a/preview/main.ts b/preview/main.ts index 9a8f776..28e8912 100644 --- a/preview/main.ts +++ b/preview/main.ts @@ -5,6 +5,8 @@ import router from './router' import { setupVant } from '@/plugins/vant' +import 'animate.css' + const app = createApp(App) // 安装vant插件 diff --git a/preview/views/slot-item.vue b/preview/views/slot-item.vue index 69d0ad3..ca49ae4 100644 --- a/preview/views/slot-item.vue +++ b/preview/views/slot-item.vue @@ -1,5 +1,5 @@