mirror of
https://github.com/vbenjs/vben-admin-thin-next.git
synced 2025-01-23 01:30:23 +08:00
chore: update readme.md
This commit is contained in:
Vben
parent
381e3a969f
commit
ee5fb223b6
@ -6,8 +6,9 @@ end_of_line=lf
|
|||||||
insert_final_newline=true
|
insert_final_newline=true
|
||||||
indent_style=space
|
indent_style=space
|
||||||
indent_size=2
|
indent_size=2
|
||||||
|
max_line_length = 100
|
||||||
|
|
||||||
[*.yml]
|
[*.{yml,yaml,json}]
|
||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
|
|||||||
38
.github/ISSUE_TEMPLATE/1-bug.md
vendored
38
.github/ISSUE_TEMPLATE/1-bug.md
vendored
@ -1,39 +1,39 @@
|
|||||||
---
|
---
|
||||||
name: 🐛 Bug report
|
name: 🐛 Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
labels: 🔍 status/open, 🐛 type/bug
|
title: ''
|
||||||
|
labels: 'bug: pending triage'
|
||||||
|
assignees: ''
|
||||||
---
|
---
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
抱歉，您遇到了一个错误。感谢您抽出宝贵的时间进行举报！
|
||||||
|
|
||||||
|
请尽可能填写以下模板。
|
||||||
|
|
||||||
Ouch, sorry you’ve run into a bug. Thank for taking the time to report it!
|
Ouch, sorry you’ve run into a bug. Thank for taking the time to report it!
|
||||||
|
|
||||||
Please fill in as much of the template below as you’re able.
|
Please fill in as much of the template below as you’re able.
|
||||||
|
|
||||||
P.S. have you seen our support and contributing docs?
|
P.S. have you seen our support and contributing docs?
|
||||||
https://github.com/get-alex/.github/blob/master/support.md
|
|
||||||
https://github.com/get-alex/.github/blob/master/contributing.md
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
### Subject of the issue
|
**⚠️ IMPORTANT ⚠️ Please check the following list before proceeding. If you ignore this issue template, your issue will be directly closed.**
|
||||||
|
|
||||||
Describe your issue here.
|
- [ ] Read [the docs](https://anncwb.github.io/vue-vben-admin-doc/).
|
||||||
|
- [ ] Make sure the code is up to date. (Some bugs have been fixed in the latest code)
|
||||||
|
- [ ] This is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/anncwb/vue-vben-admin/discussions) or join our [Discord](https://discord.gg/8GuAdwDhj6) Chat Server.
|
||||||
|
|
||||||
### Your environment
|
### Describe the bug
|
||||||
|
|
||||||
- **OS**: <!-- Name and version of operating system -->
|
A clear and concise description of what the bug is..
|
||||||
- **Packages**: <!-- Names and version of required packages -->
|
|
||||||
- **Env**: <!-- Version of node, npm, yarn, or names and versions of browser -->
|
|
||||||
|
|
||||||
### Steps to reproduce
|
### Reproduction
|
||||||
|
|
||||||
Tell us how to reproduce this issue. Please provide a working and simplified example.
|
Please describe the steps of the problem in detail to ensure that we can restore the correct problem
|
||||||
|
|
||||||
🎉 BONUS POINTS for creating a [minimal reproduction](https://stackoverflow.com/help/mcve) and uploading it to GitHub. This will get you the fastest support. 🎉
|
## System Info
|
||||||
|
|
||||||
### Expected behaviour
|
- Operating System:
|
||||||
|
- Node version:
|
||||||
What should happen?
|
- Package manager (npm/yarn/pnpm) and version:
|
||||||
|
|
||||||
### Actual behaviour
|
|
||||||
|
|
||||||
What happens instead?
|
|
||||||
|
|||||||
8
.github/ISSUE_TEMPLATE/2-feature.md
vendored
8
.github/ISSUE_TEMPLATE/2-feature.md
vendored
@ -1,12 +1,16 @@
|
|||||||
---
|
---
|
||||||
name: 🚀 Feature request
|
name: 🚀 Feature request
|
||||||
about: Suggest an idea for this project
|
about: Suggest an idea for this project
|
||||||
labels: 🔍 status/open, 🦋 type/enhancement
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
---
|
---
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Thank you for suggesting an idea to make this project better!
|
感谢您提出使这个项目更好的想法！
|
||||||
|
请尽可能填写以下模板。
|
||||||
|
|
||||||
|
Thank you for suggesting an idea to make this project better!
|
||||||
Please fill in as much of the template below as you’re able.
|
Please fill in as much of the template below as you’re able.
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|||||||
15
.github/ISSUE_TEMPLATE/3-help.md
vendored
15
.github/ISSUE_TEMPLATE/3-help.md
vendored
@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
name: Question 🤔
|
|
||||||
about: Usage question or discussion about alex.
|
|
||||||
labels: 🔍 status/open, 🙋 type/question
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
To make it easier for us to help you, please include as much useful information
|
|
||||||
as possible.
|
|
||||||
|
|
||||||
Before opening a new issue, please search existing issues:
|
|
||||||
https://github.com/search?q=org%3Aget-alex&type=Issues
|
|
||||||
|
|
||||||
|
|
||||||
-->
|
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Discord Chat
|
||||||
|
url: https://discord.gg/8GuAdwDhj6
|
||||||
|
about: Ask questions and discuss with other Vben users in real time.
|
||||||
|
- name: Questions & Discussions
|
||||||
|
url: https://github.com/anncwb/vue-vben-admin/discussions
|
||||||
|
about: Use GitHub discussions for message-board style questions and discussions.
|
||||||
BIN
.github/res/imgs/logo.png
vendored
BIN
.github/res/imgs/logo.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 1.9 KiB |
BIN
.github/res/imgs/preview1.png
vendored
BIN
.github/res/imgs/preview1.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 389 KiB |
BIN
.github/res/imgs/preview2.png
vendored
BIN
.github/res/imgs/preview2.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 548 KiB |
BIN
.github/res/imgs/preview3.png
vendored
BIN
.github/res/imgs/preview3.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 512 KiB |
BIN
.github/res/imgs/qq.jpeg
vendored
BIN
.github/res/imgs/qq.jpeg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 102 KiB |
82
.github/workflows/deploy.yml
vendored
82
.github/workflows/deploy.yml
vendored
@ -6,53 +6,53 @@ on:
|
|||||||
- main
|
- main
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
push-to-ftp:
|
# push-to-ftp:
|
||||||
if: "contains(github.event.head_commit.message, '[deploy]')"
|
# if: "contains(github.event.head_commit.message, '[deploy]')"
|
||||||
runs-on: ubuntu-latest
|
# runs-on: ubuntu-latest
|
||||||
steps:
|
# steps:
|
||||||
- name: Checkout
|
# - name: Checkout
|
||||||
uses: actions/checkout@v2
|
# uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Sed Config Base
|
# - name: Sed Config Base
|
||||||
shell: bash
|
# shell: bash
|
||||||
run: |
|
# run: |
|
||||||
sed -i 's#VITE_PUBLIC_PATH\s*=.*#VITE_PUBLIC_PATH = /next/#g' ./.env.production
|
# sed -i 's#VITE_PUBLIC_PATH\s*=.*#VITE_PUBLIC_PATH = /next/#g' ./.env.production
|
||||||
sed -i "s#VITE_BUILD_COMPRESS\s*=.*#VITE_BUILD_COMPRESS = 'gzip'#g" ./.env.production
|
# sed -i "s#VITE_BUILD_COMPRESS\s*=.*#VITE_BUILD_COMPRESS = 'gzip'#g" ./.env.production
|
||||||
cat ./.env.production
|
# cat ./.env.production
|
||||||
|
|
||||||
- name: use Node.js 14
|
# - name: use Node.js 14
|
||||||
uses: actions/setup-node@v2.1.2
|
# uses: actions/setup-node@v2.1.2
|
||||||
with:
|
# with:
|
||||||
node-version: '14.x'
|
# node-version: '14.x'
|
||||||
|
|
||||||
- name: Get yarn cache
|
# - name: Get yarn cache
|
||||||
id: yarn-cache
|
# id: yarn-cache
|
||||||
run: echo "::set-output name=dir::$(yarn cache dir)"
|
# run: echo "::set-output name=dir::$(yarn cache dir)"
|
||||||
|
|
||||||
- name: Cache dependencies
|
# - name: Cache dependencies
|
||||||
uses: actions/cache@v2
|
# uses: actions/cache@v2
|
||||||
with:
|
# with:
|
||||||
path: ${{ steps.yarn-cache.outputs.dir }}
|
# path: ${{ steps.yarn-cache.outputs.dir }}
|
||||||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
# key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
||||||
restore-keys: |
|
# restore-keys: |
|
||||||
${{ runner.os }}-yarn-
|
# ${{ runner.os }}-yarn-
|
||||||
|
|
||||||
- name: Build
|
# - name: Build
|
||||||
run: |
|
# run: |
|
||||||
yarn install
|
# yarn install
|
||||||
yarn run build
|
# yarn run build
|
||||||
|
|
||||||
- name: Deploy
|
# - name: Deploy
|
||||||
uses: SamKirkland/FTP-Deploy-Action@2.0.0
|
# uses: SamKirkland/FTP-Deploy-Action@2.0.0
|
||||||
env:
|
# env:
|
||||||
FTP_SERVER: ${{ secrets.FTP_SERVER }}
|
# FTP_SERVER: ${{ secrets.FTP_SERVER }}
|
||||||
FTP_USERNAME: ${{ secrets.FTP_USERNAME }}
|
# FTP_USERNAME: ${{ secrets.FTP_USERNAME }}
|
||||||
FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
|
# FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
|
||||||
METHOD: sftp
|
# METHOD: sftp
|
||||||
PORT: ${{ secrets.FTP_PORT }}
|
# PORT: ${{ secrets.FTP_PORT }}
|
||||||
LOCAL_DIR: dist
|
# LOCAL_DIR: dist
|
||||||
REMOTE_DIR: /srv/www/vben-admin
|
# REMOTE_DIR: /srv/www/vben-admin
|
||||||
ARGS: --delete --verbose --parallel=80
|
# ARGS: --delete --verbose --parallel=80
|
||||||
|
|
||||||
push-to-gh-pages:
|
push-to-gh-pages:
|
||||||
if: "contains(github.event.head_commit.message, '[deploy]')"
|
if: "contains(github.event.head_commit.message, '[deploy]')"
|
||||||
|
|||||||
6
.gitpod.yml
Normal file
6
.gitpod.yml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
ports:
|
||||||
|
- port: 3344
|
||||||
|
onOpen: open-preview
|
||||||
|
tasks:
|
||||||
|
- init: yarn
|
||||||
|
command: yarn dev
|
||||||
@ -1,4 +1,4 @@
|
|||||||
## 2.0.1 (2021-03-04)
|
## 2.0.2 (2021-03-04)
|
||||||
|
|
||||||
### ✨ Refactor
|
### ✨ Refactor
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
## 2.0.1 (2021-03-04)
|
## 2.0.2 (2021-03-04)
|
||||||
|
|
||||||
### ✨ Refactor
|
### ✨ Refactor
|
||||||
|
|
||||||
|
|||||||
292
README.md
292
README.md
@ -1,186 +1,105 @@
|
|||||||
<p align="center">
|
<div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br>
|
||||||
<a href="https://github.com/anncwb/vue-vben-admin" target="_blank">
|
|
||||||
<img alt="VbenAdmin Logo" width="200" src="/anncwb/vue-vben-admin/raw/main/.github/res/imgs/logo.png">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
<h2 align="center">VUE VBEN ADMIN2.0</h2>
|
|
||||||
|
|
||||||
[Chinese](./README.zh-CN.md) | **English**
|
[](LICENSE)
|
||||||
|
|
||||||
[CHANGELOG](CHANGELOG.en_US.md)
|
<h1>Vue vben admin</h1>
|
||||||
|
</div>
|
||||||
|
|
||||||
- [Introduction](#introduction)
|
**English** | [中文](./README.zh-CN.md)
|
||||||
- [GitHub](#github)
|
|
||||||
- [Thin](#thin)
|
|
||||||
- [Preview](#preview)
|
|
||||||
- [Documentation](#documentation)
|
|
||||||
- [Preinstallation](#preinstallation)
|
|
||||||
- [Environmental requirements](#environmental-requirements)
|
|
||||||
- [UI framework](#ui-framework)
|
|
||||||
- [Icon](#icon)
|
|
||||||
- [Plugin](#plugin)
|
|
||||||
- [Suggested development environment](#suggested-development-environment)
|
|
||||||
- [Install](#install)
|
|
||||||
- [Usage](#usage)
|
|
||||||
- [Development environment](#development-environment)
|
|
||||||
- [Build](#build)
|
|
||||||
- [Format](#format)
|
|
||||||
- [Other](#other)
|
|
||||||
- [Git submit specifications](#git-submit-specifications)
|
|
||||||
- [Code contribution](#code-contribution)
|
|
||||||
- [Finished features](#finished-features)
|
|
||||||
- [Developing features](#developing-features)
|
|
||||||
- [Browser support](#browser-support)
|
|
||||||
- [Plugins](#plugins)
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
The project is based on the vue3 style background management system implemented by ʻant-design-vue`, `typescript`,`vue3.0`,`vite`,`tsx`,
|
Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite2`, `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
|
## Feature
|
||||||
|
|
||||||
[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` branch
|
- **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
|
||||||
|
|
||||||
### Thin
|
## 预览
|
||||||
|
|
||||||
[vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next)
|
- [vue-vben-admin](https://vvbin.cn/next/) - Full version Chinese site
|
||||||
|
- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version of the github site
|
||||||
|
- [vben-admin-thin-next](https://vvbin.cn/thin/next/) - Simplified Chinese site
|
||||||
|
- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site
|
||||||
|
|
||||||
## Preview
|
Test account: vben/123456
|
||||||
|
|
||||||
- [2.0 preview](https://vvbin.cn/next/)
|
|
||||||
|
|
||||||
- [2.0 Thin Preview](https://vvbin.cn/thin/next/)
|
|
||||||
|
|
||||||
Account for test: vben/123456
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
### Use Gitpod
|
||||||
|
|
||||||
|
Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
|
||||||
|
|
||||||
|
[](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin)
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
The documentation for 2.0 hasn't started yet, it will be provided later.
|
[Document](https://vvbin.cn/doc-next/)
|
||||||
|
|
||||||
## Preinstallation
|
## Preparation
|
||||||
|
|
||||||
### Environmental requirements
|
- [node](http://nodejs.org/) and [git](https://git-scm.com/) - Project development environment
|
||||||
|
- [Vite](https://vitejs.dev/) - Familiar with vite features
|
||||||
|
- [Vue3](https://v3.vuejs.org/) - Familiar with Vue basic syntax
|
||||||
|
- [TypeScript](https://www.typescriptlang.org/) - Familiar with the basic syntax of `TypeScript`
|
||||||
|
- [Es6+](http://es6.ruanyifeng.com/) - Familiar with es6 basic syntax
|
||||||
|
- [Vue-Router-Next](https://next.router.vuejs.org/) - Familiar with the basic use of vue-router
|
||||||
|
- [Ant-Design-Vue](https://2x.antdv.com/docs/vue/introduce-cn/) - ui basic use
|
||||||
|
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax
|
||||||
|
|
||||||
- `Node.js`: - Version > `12.0.0` .
|
## Install and use
|
||||||
- `yarn` : - Package management tool.
|
|
||||||
|
|
||||||
### UI framework
|
- Get the project code
|
||||||
|
|
||||||
- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 has deleted.
|
|
||||||
- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/)
|
|
||||||
|
|
||||||
### Icon
|
|
||||||
|
|
||||||
- [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - Icon which is imported on demand.
|
|
||||||
- [Iconify](https://iconify.design) - Icon can be used [Icônes](https://icones.netlify.app/)
|
|
||||||
- [PurgeIcons](https://github.com/antfu/purge-icons) - Icon which is used by build.
|
|
||||||
|
|
||||||
### Plugin
|
|
||||||
|
|
||||||
- [Vue Router Next](https://github.com/vuejs/vue-router-next)
|
|
||||||
- [Vuex Next](https://github.com/vuejs/vuex)
|
|
||||||
- [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - vuex modular
|
|
||||||
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Mock plugin base on vite
|
|
||||||
- [vue-i18n](https://github.com/intlify/vue-i18n-next) - Internationalization
|
|
||||||
- [lodash-es](https://github.com/lodash/lodash) - JavaScript utility library
|
|
||||||
- [axios](https://github.com/axios/axios) - Http data interaction
|
|
||||||
- [TypeScript](https://www.typescriptlang.org/)
|
|
||||||
|
|
||||||
### Suggested development environment
|
|
||||||
|
|
||||||
- `Git`: - Tool of version management
|
|
||||||
- `Visual Studio Code` - (VSCode): Latest version
|
|
||||||
- [VS Code Extensions](./.vscode/extensions.json)
|
|
||||||
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify)
|
|
||||||
- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind css style association
|
|
||||||
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - Essential for vue development
|
|
||||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Checking script code
|
|
||||||
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code formatting
|
|
||||||
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - Css formatting
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Make git case sensitive to file names
|
git clone https://github.com/anncwb/vue-vben-admin.git
|
||||||
git config core.ignorecase false
|
```
|
||||||
|
|
||||||
# Pull code of the project
|
- Installation dependencies
|
||||||
git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0
|
|
||||||
|
|
||||||
cd vue-vben-admin-2.0
|
```bash
|
||||||
|
cd vue-vben-admin
|
||||||
|
|
||||||
# If you use other package management tool, you can install it by yourself
|
|
||||||
# if you hasn't install yarn, please run: npm install -g yarn
|
|
||||||
yarn install
|
yarn install
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
- run
|
||||||
|
|
||||||
### Development environment
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn serve
|
yarn serve
|
||||||
```
|
```
|
||||||
|
|
||||||
### Build
|
- build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
yarn build
|
||||||
yarn build # build
|
|
||||||
|
|
||||||
yarn build:no-cache # build, cache will be removed before build
|
|
||||||
|
|
||||||
yarn report # Generate build package report preview
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Format
|
## Change Log
|
||||||
|
|
||||||
```bash
|
[CHANGELOG](./CHANGELOG.zh_CN.md)
|
||||||
yarn lint:stylelint # css formatting
|
|
||||||
|
|
||||||
yarn lint:prettier # js/ts code formatting
|
## Project
|
||||||
```
|
|
||||||
|
|
||||||
### Other
|
- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - full version
|
||||||
|
- [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - Simplified version
|
||||||
|
|
||||||
```bash
|
## How to contribute
|
||||||
yarn reinstall # Remove dependencies and reinstall, supported window
|
|
||||||
|
|
||||||
yarn preview # Build and preview in local
|
You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。
|
||||||
|
|
||||||
yarn log # Generate CHANGELOG
|
**Pull Request:**
|
||||||
|
|
||||||
yarn clean:cache # Delete cache
|
|
||||||
|
|
||||||
yarn clean:lib # Delete node_modules, supported window
|
|
||||||
```
|
|
||||||
|
|
||||||
## Git submit specifications
|
|
||||||
|
|
||||||
- Refer to [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specifications ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
|
|
||||||
|
|
||||||
- `feat` Add new features
|
|
||||||
- `fix` Fix problem/BUG
|
|
||||||
- `style` Code style related and doesn't affect the running result
|
|
||||||
- `perf` Optimization/performance improvement
|
|
||||||
- `refactor` Refactor
|
|
||||||
- `revert` Undo edit
|
|
||||||
- `test` Test related
|
|
||||||
- `docs` Documentation/notes
|
|
||||||
- `chore` Dependent update/scaffolding configuration modification etc
|
|
||||||
- `workflow` Workflow improvements
|
|
||||||
- `ci` Continuous integration
|
|
||||||
- `types` Update file of type definition
|
|
||||||
- `wip` Developing
|
|
||||||
|
|
||||||
## Code contribution
|
|
||||||
|
|
||||||
1. Fork code!
|
1. Fork code!
|
||||||
2. Create your own branch: `git checkout -b feat/xxxx`
|
2. Create your own branch: `git checkout -b feat/xxxx`
|
||||||
@ -188,73 +107,62 @@ yarn clean:lib # Delete node_modules, supported window
|
|||||||
4. Push your branch: `git push origin feat/xxxx`
|
4. Push your branch: `git push origin feat/xxxx`
|
||||||
5. submit`pull request`
|
5. submit`pull request`
|
||||||
|
|
||||||
## Finished features
|
## Git Contribution submission specification
|
||||||
|
|
||||||
- [x] Project construction (based on vite）)
|
- 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))
|
||||||
- [x] Login and exit
|
|
||||||
- [x] Menu (can search, drag and drop and menu layout)
|
|
||||||
- [x] Multiple tabs/breadcrumbs
|
|
||||||
- [x] Permission management base on role
|
|
||||||
- [x] Permission management base on background
|
|
||||||
- [x] The separation of routing and menu settings
|
|
||||||
- [x] Collapsible sidebar
|
|
||||||
- [x] Draggable sidebar
|
|
||||||
- [x] Multi-tab mode/global control
|
|
||||||
- [x] Menu search
|
|
||||||
- [x] Page loading
|
|
||||||
- [x] Scroll bar component
|
|
||||||
- [x] Pop-up window expansion (dragable, full screen, adaptive height)
|
|
||||||
- [x] Mock data
|
|
||||||
- [x] hook Package
|
|
||||||
- [x] Form component
|
|
||||||
- [x] Right-click menu
|
|
||||||
- [x] Watermark plugin
|
|
||||||
- [x] Animation component
|
|
||||||
- [x] QR code plugin
|
|
||||||
- [x] Internationalization plugin
|
|
||||||
- [x] Details component
|
|
||||||
- [x] Validation component
|
|
||||||
- [x] Tree component
|
|
||||||
- [x] Picture preview component
|
|
||||||
- [x] Table component
|
|
||||||
- [x] Chart library
|
|
||||||
- [x] Digital animation
|
|
||||||
- [x] First screen loading waiting animation
|
|
||||||
- [x] Extract the production environment profile
|
|
||||||
- [x] Build Gzip
|
|
||||||
- [x] System performance optimization
|
|
||||||
- [x] Data import and export
|
|
||||||
- [x] Global error handling
|
|
||||||
- [x] Rich text component
|
|
||||||
- [x] Upload component
|
|
||||||
|
|
||||||
## Developing features
|
- `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
|
||||||
|
|
||||||
- [ ] Theme configuration
|
## Related warehouse
|
||||||
- [ ] Dark theme
|
|
||||||
- [ ] Build CDN
|
|
||||||
|
|
||||||
If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue.
|
If these plugins are helpful to you, you can give a star support
|
||||||
|
|
||||||
|
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Used for local and development environment data mock
|
||||||
|
- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - Used for html template conversion and compression
|
||||||
|
- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) - Used for component library style introduction on demand
|
||||||
|
- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme) - Used to pack compressed image resources
|
||||||
|
- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - Used for online switching of theme colors and other color-related configurations
|
||||||
|
- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - Used to pack input .gz|.brotil files
|
||||||
|
|
||||||
## Browser support
|
## Browser support
|
||||||
|
|
||||||
It is recommended to use the `Chrome` browser for local development. Development in the Firefox browser is relatively slow.
|
The `Chrome 80+` browser is recommended for local development
|
||||||
|
|
||||||
Support modern browsers, Not currently supported ie11，Follow-up consideration support ie11
|
Support modern browsers, not IE
|
||||||
|
|
||||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||||
| :-: | :-: | :-: | :-: | :-: |
|
| :-: | :-: | :-: | :-: | :-: |
|
||||||
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||||||
|
|
||||||
More browsers can view [Can I Use Es Module](https://caniuse.com/?search=ES%20Module)
|
## Maintainer
|
||||||
|
|
||||||
## Plugins
|
[@Vben](https://github.com/anncwb)。
|
||||||
|
|
||||||
If these plugins are helpful to you, you can give a star
|
## Donate
|
||||||
|
|
||||||
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock)
|
If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support!
|
||||||
- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html)
|
|
||||||
- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import)
|
|
||||||
- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme)
|
|
||||||
- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin)
|
[Paypal Me](https://www.paypal.com/paypalme/cvvben)
|
||||||
- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression)
|
|
||||||
|
## Discord
|
||||||
|
|
||||||
|
- [github discussions](https://github.com/anncwb/vue-vben-admin/discussions)
|
||||||
|
- [Discord](https://discord.gg/8GuAdwDhj6)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT © Vben-2020](./LICENSE)
|
||||||
|
|||||||
278
README.zh-CN.md
278
README.zh-CN.md
@ -1,170 +1,113 @@
|
|||||||
<p align="center">
|
<div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br>
|
||||||
<a href="https://github.com/anncwb/vue-vben-admin" target="_blank">
|
|
||||||
<img alt="VbenAdmin Logo" width="200" src="./.github/res/imgs/logo.png">
|
[](LICENSE)
|
||||||
</a>
|
|
||||||
</p>
|
<h1>Vue vben admin</h1>
|
||||||
<h2 align="center">VUE VBEN ADMIN2.0</h2>
|
</div>
|
||||||
|
|
||||||
**中文** | [English](./README.md)
|
**中文** | [English](./README.md)
|
||||||
|
|
||||||
[更新日志](CHANGELOG.zh_CN.md)
|
## 简介
|
||||||
|
|
||||||
- [介绍](#介绍)
|
Vue Vben Admin 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite2`,`TypeScript`等主流技术开发，开箱即用的中后台前端解决方案，也可用于学习参考。
|
||||||
- [gitHub 地址](#github-地址)
|
|
||||||
- [精简版地址](#精简版地址)
|
|
||||||
- [预览地址](#预览地址)
|
|
||||||
- [文档](#文档)
|
|
||||||
- [预安装](#预安装)
|
|
||||||
- [环境要求](#环境要求)
|
|
||||||
- [UI 框架](#ui-框架)
|
|
||||||
- [图标](#图标)
|
|
||||||
- [插件](#插件)
|
|
||||||
- [建议开发环境](#建议开发环境)
|
|
||||||
- [安装](#安装)
|
|
||||||
- [使用](#使用)
|
|
||||||
- [开发环境](#开发环境)
|
|
||||||
- [打包](#打包)
|
|
||||||
- [格式化](#格式化)
|
|
||||||
- [其他](#其他)
|
|
||||||
- [Git 提交规范](#git-提交规范)
|
|
||||||
- [代码贡献](#代码贡献)
|
|
||||||
- [已完成功能](#已完成功能)
|
|
||||||
- [正在开发的功能](#正在开发的功能)
|
|
||||||
- [浏览器支持](#浏览器支持)
|
|
||||||
- [插件](#插件-1)
|
|
||||||
- [加入我们](#加入我们)
|
|
||||||
|
|
||||||
## 介绍
|
## 特性
|
||||||
|
|
||||||
项目基于`ant-design-vue`,`typescript`,`vue3.0`,`vite`,`tsx`实现的 vue3 风格的后台管理系统，
|
- **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发
|
||||||
|
- **TypeScript**: 应用程序级 JavaScript 的语言
|
||||||
|
- **主题**：可配置的主题
|
||||||
|
- **国际化**：内置完善的国际化方案
|
||||||
|
- **Mock 数据** 内置 Mock 数据方案
|
||||||
|
- **权限** 内置完善的动态路由权限生成方案
|
||||||
|
- **组件** 二次封装了多个常用的组件
|
||||||
|
|
||||||
## gitHub 地址
|
## 预览
|
||||||
|
|
||||||
[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` 分支
|
- [vue-vben-admin](https://vvbin.cn/next/) - 完整版中文站点
|
||||||
|
- [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - 完整版 github 站点
|
||||||
### 精简版地址
|
- [vben-admin-thin-next](https://vvbin.cn/thin/next/) - 简化版中文站点
|
||||||
|
- [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) - 简化版 github 站点
|
||||||
[vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next)
|
|
||||||
|
|
||||||
## 预览地址
|
|
||||||
|
|
||||||
- [2.0 在线预览](https://vvbin.cn/next/)
|
|
||||||
|
|
||||||
- [2.0 精简版 在线预览](https://vvbin.cn/thin/next/)
|
|
||||||
|
|
||||||
测试账号: vben/123456
|
测试账号: vben/123456
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png">
|
||||||
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png">
|
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
### 使用 Gitpod
|
||||||
|
|
||||||
|
在 Gitpod（适用于 GitHub 的免费在线开发环境）中打开项目，并立即开始编码.
|
||||||
|
|
||||||
|
[](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin)
|
||||||
|
|
||||||
## 文档
|
## 文档
|
||||||
|
|
||||||
[文档地址,持续更新中。。，](https://vvbin.cn/doc-next/)
|
[文档地址](https://vvbin.cn/doc-next/)
|
||||||
|
|
||||||
## 预安装
|
## 准备
|
||||||
|
|
||||||
### 环境要求
|
- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
|
||||||
|
- [Vite](https://vitejs.dev/) - 熟悉 vite 特性
|
||||||
|
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
|
||||||
|
- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
|
||||||
|
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
|
||||||
|
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
|
||||||
|
- [Ant-Design-Vue](https://2x.antdv.com/docs/vue/introduce-cn/) - ui 基本使用
|
||||||
|
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
|
||||||
|
|
||||||
- `Node.js`: - 版本大于 `12.0.0`
|
## 安装使用
|
||||||
- `yarn` : - 包管理工具.
|
|
||||||
|
|
||||||
### UI 框架
|
- 获取项目代码
|
||||||
|
|
||||||
- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 已删除
|
```bash
|
||||||
- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/)
|
git clone https://github.com/anncwb/vue-vben-admin.git
|
||||||
|
```
|
||||||
|
|
||||||
### 图标
|
- 安装依赖
|
||||||
|
|
||||||
- [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - 按需引入所需图标.
|
```bash
|
||||||
- [Iconify](https://iconify.design) - 使用任何图标集中的图标 [Icônes](https://icones.netlify.app/)
|
cd vue-vben-admin
|
||||||
- [PurgeIcons](https://github.com/antfu/purge-icons) - 仅打包所使用到的图标.
|
|
||||||
|
|
||||||
### 插件
|
|
||||||
|
|
||||||
- [Vue Router Next](https://github.com/vuejs/vue-router-next)
|
|
||||||
- [Vuex Next](https://github.com/vuejs/vuex)
|
|
||||||
- [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - vuex 模块化
|
|
||||||
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 基于 vite 的 mock 插件.
|
|
||||||
- [vue-i18n](https://github.com/intlify/vue-i18n-next) - 国际化
|
|
||||||
- [lodash-es](https://github.com/lodash/lodash) - JavaScript 实用程序库
|
|
||||||
- [axios](https://github.com/axios/axios) - Http 数据交互
|
|
||||||
- [TypeScript](https://www.typescriptlang.org/)
|
|
||||||
|
|
||||||
### 建议开发环境
|
|
||||||
|
|
||||||
- `Git`: - 版本管理工具
|
|
||||||
- `Visual Studio Code` - (VSCode): 最新版本
|
|
||||||
- [VS Code Extensions](./.vscode/extensions.json)
|
|
||||||
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify)
|
|
||||||
- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind Css 样式联想
|
|
||||||
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - vue 开发必备
|
|
||||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 脚本代码检查
|
|
||||||
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 代码格式化
|
|
||||||
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - css 格式化
|
|
||||||
|
|
||||||
## 安装
|
|
||||||
|
|
||||||
```js
|
|
||||||
// 使git对文件名大小写敏感
|
|
||||||
git config core.ignorecase false
|
|
||||||
|
|
||||||
// 拉取项目代码
|
|
||||||
|
|
||||||
git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0
|
|
||||||
|
|
||||||
cd vue-vben-admin-2.0
|
|
||||||
|
|
||||||
// 如果使用别的包管理工具，可以自行安装
|
|
||||||
// 如果未安装yarn，请运行：npm install -g yarn
|
|
||||||
yarn install
|
yarn install
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 使用
|
- 运行
|
||||||
|
|
||||||
### 开发环境
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn serve
|
yarn serve
|
||||||
```
|
```
|
||||||
|
|
||||||
### 打包
|
- 打包
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
yarn build
|
||||||
yarn build # 打包
|
|
||||||
|
|
||||||
yarn build:no-cache # 打包，执行之前会先删除缓存
|
|
||||||
|
|
||||||
yarn report # 生成构建包报表预览
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 格式化
|
## 更新日志
|
||||||
|
|
||||||
```bash
|
[CHANGELOG](./CHANGELOG.zh_CN.md)
|
||||||
yarn lint:stylelint # 样式格式化
|
|
||||||
|
|
||||||
yarn lint:prettier # js/ts代码格式化
|
## 项目地址
|
||||||
```
|
|
||||||
|
|
||||||
### 其他
|
- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - 完整版
|
||||||
|
- [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - 简化版
|
||||||
|
|
||||||
```bash
|
## 如何贡献
|
||||||
yarn reinstall # 删除依赖重新装，兼容window
|
|
||||||
|
|
||||||
yarn preview # 本地进行打包预览
|
非常欢迎你的加入！[提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。
|
||||||
|
|
||||||
yarn log # 生成CHANGELOG
|
**Pull Request:**
|
||||||
|
|
||||||
yarn clean:cache # 删除缓存
|
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`
|
||||||
|
|
||||||
yarn clean:lib # 删除node_modules，兼容window系统
|
## Git 贡献提交规范
|
||||||
```
|
|
||||||
|
|
||||||
## 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))
|
- 参考 [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))
|
||||||
|
|
||||||
@ -182,90 +125,45 @@ yarn clean:lib # 删除node_modules，兼容window系统
|
|||||||
- `types` 类型定义文件更改
|
- `types` 类型定义文件更改
|
||||||
- `wip` 开发中
|
- `wip` 开发中
|
||||||
|
|
||||||
## 代码贡献
|
## 相关仓库
|
||||||
|
|
||||||
1. Fork 代码!
|
如果这些插件对你有帮助，可以给一个 star 支持下
|
||||||
2. 创建自己的分支: `git checkout -b feat/xxxx`
|
|
||||||
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
|
|
||||||
4. 推送您的分支: `git push origin feat/xxxx`
|
|
||||||
5. 提交`pull request`
|
|
||||||
|
|
||||||
## 已完成功能
|
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 用于本地及开发环境数据 mock
|
||||||
|
- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - 用于 html 模版转换及压缩
|
||||||
- [x] 项目搭建（基于 vite）
|
- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) - 用于组件库样式按需引入
|
||||||
- [x] 登录和注销
|
- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme) - 用于打包压缩图片资源
|
||||||
- [x] 菜单（可以搜索及拖拽以及菜单布局）
|
- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - 用于在线切换主题色等颜色相关配置
|
||||||
- [x] 多标签页/面包屑
|
- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - 用于打包输入.gz|.brotil 文件
|
||||||
- [x] 基于角色的权限管理
|
|
||||||
- [x] 基于后台的权限管理
|
|
||||||
- [x] 分离的路由和菜单设置
|
|
||||||
- [x] 可折叠侧边栏
|
|
||||||
- [x] 可拖拽侧边栏
|
|
||||||
- [x] 多标签页模式/全局控制
|
|
||||||
- [x] 菜单搜索
|
|
||||||
- [x] 页面加载 loading
|
|
||||||
- [x] 滚动条组件
|
|
||||||
- [x] 弹窗扩展（可拖拽,全屏,自适应高度）
|
|
||||||
- [x] 模拟数据
|
|
||||||
- [x] hook 封装
|
|
||||||
- [x] 表单组件
|
|
||||||
- [x] 右键菜单
|
|
||||||
- [x] 水印插件
|
|
||||||
- [x] 动画组件
|
|
||||||
- [x] 二维码插件
|
|
||||||
- [x] 国际化插件
|
|
||||||
- [x] 详情组件
|
|
||||||
- [x] 验证组件
|
|
||||||
- [x] 树组件
|
|
||||||
- [x] 图片预览组件
|
|
||||||
- [x] 表格组件
|
|
||||||
- [x] 图表库
|
|
||||||
- [x] 数字动画
|
|
||||||
- [x] 首屏加载等待动画
|
|
||||||
- [x] 抽取生产环境配置文件
|
|
||||||
- [x] 打包 Gzip
|
|
||||||
- [x] 数据导入导出
|
|
||||||
- [x] 系统性能优化
|
|
||||||
- [x] 全局错误处理
|
|
||||||
- [x] 富文本组件
|
|
||||||
- [x] 上传组件
|
|
||||||
- [x] 多语言支持
|
|
||||||
|
|
||||||
## 正在开发的功能
|
|
||||||
|
|
||||||
- [ ] 主题配置
|
|
||||||
- [ ] 黑暗主题
|
|
||||||
- [ ] 打包 CDN
|
|
||||||
|
|
||||||
更多组件/功能/建议/bug/欢迎提交 pr 或者 issue
|
|
||||||
|
|
||||||
## 浏览器支持
|
## 浏览器支持
|
||||||
|
|
||||||
本地开发推荐使用`Chrome`浏览器,在火狐浏览器进行开发相对卡顿。
|
本地开发推荐使用`Chrome 80+` 浏览器
|
||||||
|
|
||||||
支持现代浏览器, IE 暂不支持，后续考虑支持 ie11
|
支持现代浏览器, 不支持 IE
|
||||||
|
|
||||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||||||
| :-: | :-: | :-: | :-: | :-: |
|
| :-: | :-: | :-: | :-: | :-: |
|
||||||
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||||||
|
|
||||||
更多浏览器可以查看 [Can I Use Es Module](https://caniuse.com/?search=ES%20Module)
|
## 维护者
|
||||||
|
|
||||||
## 插件
|
[@Vben](https://github.com/anncwb)
|
||||||
|
|
||||||
如果这些插件对你有帮助，可以给一个 star 支持下
|
## 捐赠
|
||||||
|
|
||||||
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock)
|
如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持!
|
||||||
- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html)
|
|
||||||
- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import)
|
|
||||||
- [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme)
|
|
||||||
- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin)
|
|
||||||
- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression)
|
|
||||||
|
|
||||||
## 加入我们
|
|
||||||
|
|
||||||
`Vue-Vben-Aadmin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群(项目刚起步，人数较少，有兴趣的可以加群一起讨论)，使用问题欢迎在群内提问。
|
[Paypal Me](https://www.paypal.com/paypalme/cvvben)
|
||||||
|
|
||||||
|
## 交流
|
||||||
|
|
||||||
|
`Vue-vben-Admin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。
|
||||||
|
|
||||||
- QQ 群 `569291866`
|
- QQ 群 `569291866`
|
||||||
|
|
||||||
<img alt="VbenAdmin Logo" width="100" src="./.github/res/imgs/qq.jpeg">
|
## License
|
||||||
|
|
||||||
|
[MIT © Vben-2020](./LICENSE)
|
||||||
|
|||||||
@ -1,6 +1,5 @@
|
|||||||
import { createProdMockServer } from 'vite-plugin-mock/es/createProdMockServer';
|
import { createProdMockServer } from 'vite-plugin-mock/es/createProdMockServer';
|
||||||
|
|
||||||
// @ts-ignore
|
|
||||||
const modules = import.meta.globEager('./**/*.ts');
|
const modules = import.meta.globEager('./**/*.ts');
|
||||||
|
|
||||||
const mockModules: any[] = [];
|
const mockModules: any[] = [];
|
||||||
|
|||||||
@ -110,7 +110,7 @@
|
|||||||
"vite-plugin-pwa": "^0.5.6",
|
"vite-plugin-pwa": "^0.5.6",
|
||||||
"vite-plugin-style-import": "^0.7.6",
|
"vite-plugin-style-import": "^0.7.6",
|
||||||
"vite-plugin-theme": "^0.4.8",
|
"vite-plugin-theme": "^0.4.8",
|
||||||
"vite-plugin-windicss": "0.6.4",
|
"vite-plugin-windicss": "0.6.5",
|
||||||
"vue-eslint-parser": "^7.6.0",
|
"vue-eslint-parser": "^7.6.0",
|
||||||
"yargs": "^16.2.0"
|
"yargs": "^16.2.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@ -91,8 +91,8 @@
|
|||||||
const icons = getIcons();
|
const icons = getIcons();
|
||||||
export default defineComponent({
|
export default defineComponent({
|
||||||
name: 'IconPicker',
|
name: 'IconPicker',
|
||||||
inheritAttrs: false,
|
|
||||||
components: { [Input.name]: Input, Icon, Popover, ScrollContainer, Pagination, Empty },
|
components: { [Input.name]: Input, Icon, Popover, ScrollContainer, Pagination, Empty },
|
||||||
|
inheritAttrs: false,
|
||||||
props: {
|
props: {
|
||||||
value: propTypes.string,
|
value: propTypes.string,
|
||||||
width: propTypes.string.def('100%'),
|
width: propTypes.string.def('100%'),
|
||||||
|
|||||||
@ -26,7 +26,7 @@
|
|||||||
import type { PropType } from 'vue';
|
import type { PropType } from 'vue';
|
||||||
import { defineComponent, ref } from 'vue';
|
import { defineComponent, ref } from 'vue';
|
||||||
|
|
||||||
import { Dropdown, Menu, Checkbox, Input } from 'ant-design-vue';
|
import { Dropdown, Menu, Input } from 'ant-design-vue';
|
||||||
import { Icon } from '/@/components/Icon';
|
import { Icon } from '/@/components/Icon';
|
||||||
import { BasicTitle } from '/@/components/Basic';
|
import { BasicTitle } from '/@/components/Basic';
|
||||||
|
|
||||||
@ -45,7 +45,6 @@
|
|||||||
components: {
|
components: {
|
||||||
BasicTitle,
|
BasicTitle,
|
||||||
Icon,
|
Icon,
|
||||||
Checkbox,
|
|
||||||
Dropdown,
|
Dropdown,
|
||||||
Menu,
|
Menu,
|
||||||
MenuItem: Menu.Item,
|
MenuItem: Menu.Item,
|
||||||
|
|||||||
18
yarn.lock
18
yarn.lock
@ -1780,10 +1780,10 @@
|
|||||||
dependencies:
|
dependencies:
|
||||||
vue-demi latest
|
vue-demi latest
|
||||||
|
|
||||||
"@windicss/plugin-utils@0.6.4":
|
"@windicss/plugin-utils@0.6.5":
|
||||||
version "0.6.4"
|
version "0.6.5"
|
||||||
resolved "https://registry.npmjs.org/@windicss/plugin-utils/-/plugin-utils-0.6.4.tgz#854f411b156fea61b2e6724799e91f0f9407a637"
|
resolved "https://registry.npmjs.org/@windicss/plugin-utils/-/plugin-utils-0.6.5.tgz#c37082ea3e52c605508e7fb9b7331cb80b140441"
|
||||||
integrity sha512-5RZQ71snmoKmZEXHyCByOohUM/SsWIX856+geMwOfbMOGL0guv/1TVg2PalFrZh3k/HfqQnO2ft5YSWKtrW32A==
|
integrity sha512-8ZZdauxS+d3AE7RQtk7R6cWgiHQ/IUvavv0vsfXHKdvEkwMyI/GUU01VLWTXWRsWyM2+D2F6/HOgUxmxYQx5Sg==
|
||||||
dependencies:
|
dependencies:
|
||||||
esbuild "^0.8.54"
|
esbuild "^0.8.54"
|
||||||
esbuild-register "^2.0.0"
|
esbuild-register "^2.0.0"
|
||||||
@ -8957,12 +8957,12 @@ vite-plugin-theme@^0.4.8:
|
|||||||
es-module-lexer "^0.3.26"
|
es-module-lexer "^0.3.26"
|
||||||
tinycolor2 "^1.4.2"
|
tinycolor2 "^1.4.2"
|
||||||
|
|
||||||
vite-plugin-windicss@0.6.4:
|
vite-plugin-windicss@0.6.5:
|
||||||
version "0.6.4"
|
version "0.6.5"
|
||||||
resolved "https://registry.npmjs.org/vite-plugin-windicss/-/vite-plugin-windicss-0.6.4.tgz#2d2bc7831dddff129d597959efaff616c6408a01"
|
resolved "https://registry.npmjs.org/vite-plugin-windicss/-/vite-plugin-windicss-0.6.5.tgz#14b6fc43fcbc2dc143b33c83c58e3f7fe820aa9a"
|
||||||
integrity sha512-4BuUglBXeNIrIDfSKyg7rvqKEmxvyja2aKJxgHdOCICV8jIz2MvrZaRS9a74gUihz+OohBYqLnkOlfD+sCIQBg==
|
integrity sha512-zEpPlVRaXQbgA0Tsj/N4Kt1jAEZ2aMqVrq4/LaTekS0LCdtD1sQXoadAz2Af/N+qA7ICu8VBpijONH6c8AS4Xg==
|
||||||
dependencies:
|
dependencies:
|
||||||
"@windicss/plugin-utils" "0.6.4"
|
"@windicss/plugin-utils" "0.6.5"
|
||||||
windicss "^2.2.3"
|
windicss "^2.2.3"
|
||||||
|
|
||||||
vite@^2.0.5:
|
vite@^2.0.5:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user