Go to file

Snoword a368c21fb9 fix: the warning of VSCode extensions		2022-05-12 08:56:11 +08:00
.github/workflows	workflow: add contributors-readme-action	2022-04-12 09:05:51 +08:00
.husky	build: delete useless dependencies	2022-04-15 09:28:50 +08:00
.vscode	fix: the warning of VSCode extensions	2022-05-12 08:56:11 +08:00
mock	feat: add useCrudSchemas hook	2022-04-26 15:03:48 +08:00
plop	perf: add plop	2022-04-08 19:54:59 +08:00
public	feat: Add example-dialog demo	2022-02-19 13:17:38 +08:00
src	Merge branch 'develop'	2022-05-07 16:53:23 +08:00
types	feat: add useCrudSchemas hook	2022-04-26 15:03:48 +08:00
.env.base	build: Add vite-plugin-html plugin	2022-02-19 15:57:41 +08:00
.env.dev	build: Add vite-plugin-html plugin	2022-02-19 15:57:41 +08:00
.env.gitee	workflow: Add build scripts for gitee	2022-02-21 21:44:57 +08:00
.env.pro	build: Add vite-plugin-html plugin	2022-02-19 15:57:41 +08:00
.env.test	build: 集成基础配置	2021-12-07 16:36:16 +08:00
.eslintignore	wip: example demo developing	2022-02-13 11:08:11 +08:00
.eslintrc.js	build(pinia): Add pinia	2021-12-11 11:46:10 +08:00
.gitignore	build(types): Add vue-types	2021-12-10 17:10:51 +08:00
.prettierignore	chore: remove .hbs file submission check	2022-03-27 10:23:46 +08:00
.stylelintignore	build: 集成基础配置	2021-12-07 16:36:16 +08:00
CHANGELOG.md	chore(master): release 1.3.2	2022-05-07 16:53:55 +08:00
LICENSE	docs: update LICENSE	2022-03-22 13:54:45 +08:00
README.md	contrib-readme-action has updated readme	2022-04-17 18:38:30 +08:00
README.zh-CN.md	contrib-readme-action has updated readme	2022-04-17 18:38:29 +08:00
commitlint.config.js	build: 集成基础配置	2021-12-07 16:36:16 +08:00
index.html	build: Add vite-plugin-html plugin	2022-02-19 15:57:41 +08:00
package.json	chore(master): release 1.3.2	2022-05-07 16:53:55 +08:00
plopfile.js	perf: add plop	2022-04-08 19:54:59 +08:00
pnpm-lock.yaml	fix: fix the problem that the page is stuck in top mode	2022-05-07 16:51:31 +08:00
postcss.config.js	build: 集成基础配置	2021-12-07 16:36:16 +08:00
prettier.config.js	build(pinia): Add pinia	2021-12-11 11:46:10 +08:00
stylelint.config.js	build: 配置代码格式化	2021-12-07 17:16:17 +08:00
tsconfig.json	release: v3 release test	2022-02-19 09:37:38 +08:00
vite.config.ts	build: update server port	2022-03-26 10:14:24 +08:00
windi.config.ts	feat(Layout): Add cutMenu layout	2022-01-21 16:17:40 +08:00

README.md

vue-element-plus-admin

English | 中文

Introduction

vue-element-plus-admin is a free and open source middle and background template based on element-plus. Developed using the latest mainstream technologies such as vue3, vite2 and typescript, the out of the box middle and background front-end solution can be used as the starting template of the project and learning reference. And always pay attention to the latest technological trends and update them as soon as possible.

vue-element-plus-admin is positioned as a background integration scheme, which is not suitable for secondary development as a basic template. Because it integrates many functions that you may not use, it will cause a lot of code redundancy. If your project doesn't pay attention to this problem, you can also directly carry out secondary development based on it.

If you need a basic template, please switch to the tempalte branch. Tempalte simply integrates some common layout functions such as layout and dynamic menu, which is more suitable for developers to carry out secondary development.

Feature

State of The Art Development：Use front-end front-end technology development such as Vue3/vite2
TypeScript: Application-level JavaScript language
Theming: Configurable themes
International：Built-in complete internationalization program
Mock Server Built-in mock data scheme
Authority Built-in complete dynamic routing permission generation scheme.
Component Multiple commonly used components are encapsulated twice
Examples Built-in rich examples

Preview

vue-element-plus-admin - Full version of the github site
vue-element-plus-admin - Full version of the gitee site

account: admin/admin test/test

admin account is used to simulate the control permission of the server, and render whatever the server returns

test account is used to simulate the front-end control authority. The server only returns the menu key to be displayed, and the front-end performs matching rendering

Documentation

Document Github

Document Gitee

Preparation

node and git - Project development environment
Vite - Familiar with vite features
Vue3 - Familiar with Vue basic syntax
TypeScript - Familiar with the basic syntax of TypeScript
Es6+ - Familiar with es6 basic syntax
Vue-Router-Next - Familiar with the basic use of vue-router
Element-Plus - Familiar with the basic use of element-plus
Mock.js - mockjs basic syntax

Install and use

Get the project code

git clone https://github.com/kailong321200875/vue-element-plus-admin.git

Installation dependencies

cd vue-element-plus-admin

pnpm install

pnpm run dev

build

pnpm run build:pro

Change Log

CHANGELOG

How to contribute

You can Raise an issue Or submit a Pull Request.

Pull Request:

Fork code
Create your own branch: git checkout -b feat/xxxx
Submit your changes: git commit -am 'feat(function): add xxxxx'
Push your branch: git push origin feat/xxxx
submit pull request

Git Contribution submission specification

feat New features
fix Fix bugs
docs document
style Format and style (changes that do not affect code operation)
refactor Refactor
perf Optimize related, such as improving performance and experience
test Add test
build Compilation related modifications, changes to project construction or dependencies
ci Continuous integration modification
chore Changes in the construction process or auxiliary tools
revert Rollback to previous version
workflow Workflow improvement
mod Uncertain modification classification
wip Under development
types type