Vue Vben Admin

English | 中文 | 日本語

Deploy

本项目支持通过脚本一键打包并部署到远程服务器。

使用方式

pnpm deploy <环境>

• 环境参数: dev（测试环境）或 pro（正式环境）

• 例：pnpm deploy pro

支持的项目

序号	项目名称	目录
1	web-ele	apps/web-ele
2	antd-vue	apps/web-antd
3	naive-ui	apps/web-naive
4	tdesign	apps/web-tdesign

部署流程

1. 运行命令后，根据提示选择要部署的项目（输入序号或项目名称）
2. 脚本自动执行对应项目的构建命令
3. 构建完成后，通过 SCP 将产物上传到目标服务器

注意: 首次使用前请在 deploy.mjs 中配置服务器信息：

const server = {
  dev: {
    host: '',       // 服务器地址
    port: '22',     // SSH 端口
    username: '',   // 登录用户名
    password: '',   // 登录密码
    path: '',       // 部署目标路径
  },
  pro: {
    host: '',
    port: '22',
    username: '',
    password: '',
    path: '',
  },
}

Introduction

Vue Vben Admin is a free and open source middle and back-end template. Using the latest vue3, vite, 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.

Upgrade Notice

This is the latest version, 5.0, and it is not compatible with previous versions. If you are starting a new project, it is recommended to use the latest version. If you wish to view the old version, please use the v2 branch.

Features

• Latest Technology Stack: Developed with cutting-edge front-end technologies like Vue 3 and Vite
• TypeScript: A language for application-scale JavaScript
• Themes: Multiple theme colors available with customizable options
• Internationalization: Comprehensive built-in internationalization support
• Permissions: Built-in solution for dynamic route-based permission generation

Preview

• Vben Admin - Full version Chinese site

Test Account: vben/123456

Use Gitpod

Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.

Documentation

Document

Install and Use

1. Get the project code

git clone https://github.com/vbenjs/vue-vben-admin.git

1. Install dependencies

cd vue-vben-admin
npm i -g corepack
pnpm install

1. Run

pnpm dev

1. Build

pnpm build

Change Log

CHANGELOG

How to Contribute

You are very welcome to join! Raise an issue or submit a Pull Request.

Pull Request Process:

1. Fork the code
2. Create your 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 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.
• ci Continuous integration
• types Type definition file changes

Browser Support

The Chrome 80+ browser is recommended for local development

Support modern browsers, not IE

Edge	Firefox	Chrome	Safari
last 2 versions	last 2 versions	last 2 versions	last 2 versions

Maintainer

@Vben

Star History

Donate

If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support!

Paypal Me

Contributors

Discord

• Github Discussions

License

MIT © Vben-2020