dd-plus-ui
大道移动端全平台UI组件库, 基于京东 Nutui,使用 Vue 技术栈开发小程序/H5应用,统一移动应用Ui库,提升开发效率,改善开发体验。
技术栈
Vite:下一代前端开发与构建工具 VitePress:Vue 驱动的静态网站生成器,用于文档编写 NutUI:京东风格的轻量级移动端 Vue 组件库 Vue3:渐进式 JavaScript 框架
目录结构
|-- dd-plus-ui
|-- index.html
|-- package.json
|-- vite.config.resolver.ts
|-- vite.config.ts
|-- jest.config.cjs
|-- ...
|-- docs
| |-- index.md
| |-- .vitepress
| | |-- config.js
| | |-- theme
| | |-- index.js
| | |-- Layout.vue
| |-- DButton
| | |-- index.md
| |-- ...
|-- src
|-- App.vue
|-- config.json
|-- main.ts
|-- router.ts
|-- style.css
|-- assets
|-- packages
| |-- index.ts
| |-- DButton
| | |-- demo.vue
| | |-- index.ts
| | |-- index.vue
| |-- ...
|-- resolver
|-- utils
|-- views
-
docs/.vitepress
: 该目录下放vitepress文档生成器相关文件;包括文档生成的配置与组件介绍 -
docs/.vitepress/config.js
: 文档生成配置文件 -
docs/.vitepress/theme
: 文档生成自定义主题相关文件 -
docs/.vitepress/DButton
: button组件文档,每个组件都是一个单独的文档 -
src/packages
: 该目录下放所有组件定义相关文件 -
src/packages/index.ts
: 按需导出所有组件 -
src/packages/DButton
: button组件定义相关的文件夹,每个组件都是一个文件夹;其中demo.vue用于demo演示;index.ts用于组件注册;index.vue用于定义组件;__tests__单元测试相关文件 -
src/config.json
: 组件与文档配置文件,用于生成demo与文档左侧菜单栏 -
src/router.ts
: demo的路由 -
vite.config
: 打包与启动相关配置 -
jest.config
: 单元测试配置
安装与启动
- 安装依赖:
npm install
或yarn
- 项目启动:
npm run dev
(默认启动5172端口) - 项目打包:
npm run build
- 文档启动:
npm run docs:dev
(默认启动5173端口) - 文档打包:
npm run docs:build
代码提交
代码提交时会使用eslint校验代码;如果git commit失败,请检查并修复错误代码