Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

docs(README): Update README file #82

Merged
merged 2 commits into from
Sep 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# vben3

## Introduction

Vben3 is a free and open source middle and back-end template. Using the latest `vue3`, `vite4`, `TypeScript` and other mainstream technology development, the out-of-the-box middle and back-end front-end solutions can also be used for learning reference.

+ Github:[https://github.com/vbenjs/vben3](https://github.com/vbenjs/vben3)
+ Document:[https://github.com/vbenjs/vben3-doc](https://github.com/vbenjs/vben3-doc)
+ KOOK:[https://kook.top/6ZPFKi](https://kook.top/6ZPFKi)
+ Vben3 QQ group:4286109



## Install

```
git clone https://github.com/vbenjs/vben3.git
pnpm i
pnpm dev
```



## How to contribute

You are very welcome to join![Raise an issue](https://github.com/vbenjs/vben3/issues/new/choose) Or submit a Pull Request。

**Pull Request:**

1. Fork code!
2. Create your own branch: `git checkout -b feat/xxxx`
3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
4. Push your branch: `git push origin feat/xxxx`
5. submit`pull request`



## Git Contribution submission specification

- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
- `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



## License

Vben3 is MIT licensed. See the [LICENSE](https://github.com/vbenjs/vben3/blob/master/LICENSE) file for details.
59 changes: 59 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# vben3 后台管理系统

## 简介

Vben3 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite4`,`TypeScript`等主流技术开发,开箱即用的中后台前端解决方案,也可用于学习参考。

+ 项目仓库地址:[https://github.com/vbenjs/vben3](https://github.com/vbenjs/vben3)
+ 文档仓库地址:[https://github.com/vbenjs/vben3-doc](https://github.com/vbenjs/vben3-doc)
+ KOOK:[https://kook.top/6ZPFKi](https://kook.top/6ZPFKi)
+ Vben3 QQ群:4286109



## 安装

```
git clone https://github.com/vbenjs/vben3.git
pnpm i
pnpm dev
```



## 如何贡献

非常欢迎你的加入![提一个 Issue](https://github.com/vbenjs/vben3/issues/new/choose) 或者提交一个 Pull Request。

**Pull Request:**

1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交`pull request`



## Git 贡献提交规范

- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
- `feat` 增加新功能
- `fix` 修复问题/BUG
- `style` 代码风格相关无影响运行结果的
- `perf` 优化/性能提升
- `refactor` 重构
- `revert` 撤销修改
- `test` 测试相关
- `docs` 文档/注释
- `chore` 依赖更新/脚手架配置修改等
- `workflow` 工作流改进
- `ci` 持续集成
- `types` 类型定义文件更改
- `wip` 开发中



## 许可证

Halo 使用 MIT 协议开源。
2 changes: 1 addition & 1 deletion apps/admin/src/pages/sys/login/login-form.vue
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ async function handleLogin() {
{{t('sys.login.mobileSignInFormTitle')}}
</vben-button>
</vben-grid-item>
<vben-grid-item :md="8" :xs="24" class="!my-2 md:!my-0 xs:mx-0 md:mx-2">
<vben-grid-item :md="8" :xs="24" class="md:!my-0 xs:mx-0 md:mx-2">
<vben-button block @click="setLoginState(LoginStateEnum.QR_CODE)">
{{t('sys.login.qrSignInFormTitle')}}
</vben-button>
Expand Down