README.en-US.md

vben3

English | 简体中文

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
• Document：https://github.com/vbenjs/vben3-doc
• KOOK：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 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 -m 'feat(function): add xxxxx'
4. Push your branch: git push origin feat/xxxx
5. submit: pull request

Git Contribution submission specification

• reference vue specification (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 file for details.