Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xingorg1/xingorg1-ui
自建vue3组件库
https://github.com/xingorg1/xingorg1-ui
componet vue-next xingorg1
Last synced: 6 days ago
JSON representation
自建vue3组件库
- Host: GitHub
- URL: https://github.com/xingorg1/xingorg1-ui
- Owner: xingorg1
- License: mit
- Created: 2020-10-31T13:39:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-21T04:02:14.000Z (about 4 years ago)
- Last Synced: 2024-12-15T11:08:30.287Z (21 days ago)
- Topics: componet, vue-next, xingorg1
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/xingorg1-ui
- Size: 686 KB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# xingorg1-ui
> 最新版迁移至团队[前端印记](https://github.com/DFE-evernote/axe-ui)，欢迎大家一起加入协作～
基于[email protected]的一套PC端前端UI组件库
## 技术栈
* [Vue3.0](https://cn.vuejs.org/)
* [TypeScript](https://www.tslang.cn/)
* [Dart Scss](https://sass-lang.com/)
* [Mocha](https://mochajs.org/) + [chai](https://www.chaijs.com/)
* [Eslint](https://eslint.bootcss.com/)
## 目录结构
```bash
.
├─ 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](https://nodejs.org/en/) version 8.9 or above (v10+ recommended). You can manage multiple versions of Node on the same machine with [n](https://github.com/tj/n), [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows).
### 2、升级cli
本项目是使用vue-cli搭建项目框架，需要用vue3，得先把vue-cli的版本升级到`[email protected]`以上：
```
npm install -g @vue/cli
```
> 因为不更新版本直接install，会报[vue-loader-v16](https://github.com/vuejs/vue-cli/pull/5718#issuecomment-673360542)相关的错。但是这个问题在[[email protected]修复](https://github.com/vuejs/vue-cli/blob/dev/CHANGELOG.md#bug-bug-fix-7)了。所以推荐更新的到最新版～
### 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](https://cli.vuejs.org/config/).