vue-vben-admin README

The project's README from github.com/vbenjs/vue-vben-admin. As one markdown file: README.md.

VbenAdmin Logo

license

Vue Vben Admin

Quality Gate Status codeql build ci deploy

English | 中文 | 日本語

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

Preview

Test Account: vben/123456

VbenAdmin Logo VbenAdmin Logo VbenAdmin Logo

Use Gitpod

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

Open in Gitpod

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)

Browser Support

Tailwind CSS v4.0 is designed for Safari 16.4+, Chrome 111+, and Firefox 128+

Support modern browsers, not IE

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

Maintainer

@Vben

Star History

Star History Chart

Donate

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

donate

Paypal Me

Contributors

Contribution Leaderboard Contributors

Discord

License

MIT © Vben-2020

vue-vben-admin (vbenjs/vue-vben-admin)

admin-template
Searching Database…

What is this?Vue Vben Admin is a free, open-source middle and back-end admin panel template built with Vue3, Vite, TypeScript, and a monorepo structure, meant to be used out-of-the-box or as a learning reference.
Is this a framework, a library, or a ready-made template I run?It is a ready-made admin dashboard template/starter project (a monorepo with multiple UI variants), not a library you import into an existing app.
How do I get it running?Clone the repo, install dependencies with pnpm, then run the dev command, and build when ready.
What do I need installed before running this?You need Node.js (v22.18+ or v24.12+) and pnpm (v11 or newer) to install dependencies and run the project.
Can I upgrade an older Vben Admin project to this version?No, version 5.0 is not backward compatible with older versions; new projects should use the latest version, and users of the old version should stay on the v2 branch.
Does it work in old browsers like IE?No, it only supports modern browsers (last 2 versions of Edge, Firefox, Chrome, Safari) and explicitly drops IE support.
What UI component libraries can I choose from?The project ships with multiple front-end variants built on different UI kits, including Ant Design, Element Plus, Naive UI, and Shadcn UI, so you can pick the design system that fits your needs.
Can I try it without installing anything locally?Yes, you can open the project directly in Gitpod, a free online dev environment linked from GitHub, and start coding immediately without local setup.
Does it include internationalization and permission handling out of the box?Yes, it has comprehensive built-in internationalization support and a built-in solution for dynamic route-based permission generation.
Is there a live demo I can test?Yes, there's a full-version preview site (Chinese site) with a test account (vben/123456) to explore the admin panel before installing it.
Creator
vbenjs
Size
47.7 MB
Stars
33.6K
Age
6y
Commits · 90 Days