xingorg1-ui

最新版迁移至团队前端印记，欢迎大家一起加入协作～

基于[email protected]的一套PC端前端UI组件库

技术栈

• Vue3.0
• TypeScript
• Dart Scss
• Mocha + chai
• Eslint

目录结构

.
├─ README.md
├─ package.json
├─ docs # 组件使用文档
│  └─ button.md
├─ packages # 组件源码
│  ├─ button # 单组件
│  │  ├─ src
│  │  │  └─ button.vue
│  │  └─ index.js
│  └─ index.js # 全部组件入口
├─ public
│  ├─ img
│  │  └─ icons # 存放pwa 图标
│  ├─ favicon.ico
│  ├─ index.html
│  └─ robots.txt
├─ src # demo样式
│  ├─ components # 存放单元组件使用Demo
│  ├─ App.vue
│  └─ main.ts
├─ styles # 组件样式
│  ├─ common
│  │  ├─ _var.scss # 全局scss变量
│  │  └─ xxx.scss
│  ├─ mixin # 混合
│  │  └─ xxx.scss
│  └─ button.scss # 组件单样式
└─ tests
   └─ utils # 单元测试
      └─ xx.spec.ts # xx模块测试文件

依赖安装

1、环境要求

• node： 8.9+ (推荐 10+)
• npm： 6+

Vue CLI requires Node.js version 8.9 or above (v10+ recommended). You can manage multiple versions of Node on the same machine with n, nvm or nvm-windows.

2、升级cli

本项目是使用vue-cli搭建项目框架，需要用vue3，得先把vue-cli的版本升级到[email protected]以上：

npm install -g @vue/cli

因为不更新版本直接install，会报vue-loader-v16相关的错。但是这个问题在[email protected]修复了。所以推荐更新的到最新版～

3、安装依赖：

npm install

host配置

因为服务启动后需要访问域名，故可以先进行配置：

#### xingorg1-ui
127.0.0.1 dev.xingorg1-ui.com

开发环境（编译+热更新）

npm run serve
# or
npm run dev

生产环境（打包+压缩）

npm run build

单元测试

npm run test:unit

代码校验和修复

npm run lint

自定义配置

See Configuration Reference.