Skip to content

Commit

Permalink
feat: 增加readme文件
Browse files Browse the repository at this point in the history
  • Loading branch information
moyuand committed Nov 30, 2024
1 parent 5eee9a8 commit 874294d
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
search: false
next:
link: /components/button
text: Button 按钮
---
# 最新 Vue3 + TS 高仿 ElementPlus 打造自己的组件库

## 安装


```bash
npm i moyuand-ui --save
```

## 开始使用

**全局使用**


```js
// 引入所有组件
import MoyuUI from 'moyu-ui'
// 引入样式
import 'moyu-ui/dist/style.css'

import App from './App.vue'
// 全局使用
createApp(App).use(MoyuUI).mount('#app')
```

```vue
<template>
<er-button>我是 Button</er-button>
</template>
```

**单个导入**

Eric-UI 提供了基于 ES Module 的开箱即用的 Tree Shaking 功能。


```vue
<template>
<my-button>我是 Button</my-button>
</template>
<script>
import { myButton } from ' moyu-ui'
export default {
components: { MyButton },
}
</script>
```

## 亮点

::: details
- Vite + Vitest + Vitepress 工具链
- monorepo 分包管理
- github actions 实现 CI/CD 自动化部署
- 大模型辅助:使用大模型辅助完成需求分析,设计思路,快速实现组件,提升开发效率。
- 当然,也会展示 发布“开箱即用” 的 npm 包
:::

<!-- * 亮点1 🔥:“稀有”,目前上市面没有类似的高级课程,由浅入深的高仿 Element-Plus 完成组件库开发的全流程。
* 亮点2 💧: “专业”,传授大厂前端项目架构设计思想/开发模式/代码规范/流程,不搞小作坊式代码。
* 亮点3 ⛑️: “全”,精选十几个组件,可以涵盖大部分的主流组件的设计思想以及原理,知识覆盖面全。
* 亮点4 📚:“新”,使用目前2023年 Vue3 周边最新 ,最全技术:Vue3.2 + Typescript4, Vite,Vitest, Vitepress,Vue-test-utils2,Rollup, Postcss 一网打尽。
* 亮点5 🎉:“难”,难度逐渐上升,高薪必备敲门砖,包括:Message - Select - Form 这种高难度高复杂组件。
* 亮点6 🌹:单元测试,被常年忽略但是非常重要的内容,简历加分项,使用最新的 Vitest,Vue-test-utils2 完成单元测试。
* 亮点7 📚: 文档生成工具,组件库打包和发布以及其他周边流程应有尽有,提供一揽子解决方案。
* 亮点8 📦: 长期维护以及更新,会根据同学的反馈每年更新几个高频组件。 -->

0 comments on commit 874294d

Please sign in to comment.