You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
li-yi-hong
960f1d3c0b
|
4 days ago | |
---|---|---|
.github | 5 months ago | |
.husky | 2 months ago | |
.vscode | 5 months ago | |
apps | 6 months ago | |
internal | 3 months ago | |
mock | 9 months ago | |
packages | 5 months ago | |
public | 1 year ago | |
src | 4 days ago | |
types | 5 months ago | |
.browserslistrc | 1 year ago | |
.commitlintrc.cjs | 5 months ago | |
.dockerignore | 1 year ago | |
.editorconfig | 4 years ago | |
.env | 1 year ago | |
.env.analyze | 5 months ago | |
.env.development | 5 months ago | |
.env.docker | 5 months ago | |
.env.production | 5 months ago | |
.env.test | 5 months ago | |
.eslintignore | 10 months ago | |
.eslintrc.cjs | 9 months ago | |
.gitattributes | 2 years ago | |
.gitignore | 1 year ago | |
.gitpod.yml | 3 years ago | |
.npmrc | 5 months ago | |
.prettierignore | 1 year ago | |
.prettierrc.cjs | 9 months ago | |
.stylelintignore | 1 year ago | |
.stylelintrc.cjs | 9 months ago | |
CHANGELOG.en_US.md | 5 months ago | |
CHANGELOG.md | 4 months ago | |
CHANGELOG.zh_CN.md | 3 years ago | |
CNAME | 2 years ago | |
Dockerfile | 5 months ago | |
LICENSE | 4 years ago | |
README.md | 4 months ago | |
README.zh-CN.md | 4 months ago | |
index.html | 6 months ago | |
nginx.conf | 9 months ago | |
package.json | 3 months ago | |
pnpm-lock.yaml | 3 months ago | |
pnpm-workspace.yaml | 1 year ago | |
tsconfig.json | 10 months ago | |
turbo.json | 1 year ago | |
uno.config.ts | 10 months ago | |
vite.config.ts | 7 months ago |
README.md
English | 中文
Introduction
Vue Vben Admin is a free and open source middle platform/back-end template. Using the latest vue3
, vite4
, TypeScript
and other mainstream technology, Vben is the out-of-the-box front-end solution for both production and learning purpose.
Features
- State-of-art Techinical Stack:Using the latest and popular front-end technology such as Vue3/vite2
- TypeScript: Application-level JavaScript language
- Theming: Configurable themes
- International:Built-in i18n support
- Response Mock: Built-in response mock ability
- Authority: Built-in permission system based on dynamic routes.
- Component: Extracted and encapsulated components for various scenarios.
Preview
- vue-vben-admin - Full version (Chinese)
- vue-vben-admin-gh-pages - Full version (github hosted)
- vben-admin-thin-next - Simplified Version (Chinese)
- vben-admin-thin-gh-pages -Simplified Version (github hosted)
Test account: vben/123456
Use Gitpod
Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
Documentation
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
- Ant-Design-Vue - ui basic use
- Mock.js - mockjs basic syntax
Install and use
- Get the project code
git clone https://github.com/vbenjs/vue-vben-admin.git
- Install dependencies
cd vue-vben-admin
pnpm install
- run
pnpm serve
- build
pnpm build
- docker
The dockerFile is located in the project root directory and supports differential deployment
build image
docker build -t vue-vben-admin .
Use environment variables to achieve differentiated container deployment. Specify service endpoint by assigning VG_BASE_URL
. In the following example, http://localhost:3333
is used as the back-end service address and the container is mapped to port 6666
:
docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin
Then you can navigate to http://localhost:6666
Change Log
Project
- vue-vben-admin - full version
- vue-vben-admin-thin-next - Simplified version
How to contribute
You are very welcome to join!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
-
reference vue specification (Angular)
feat
Add new featuresfix
Fix the problem/BUGstyle
Modify the code style/format that does not affect the featureperf
Optimization/performance improvementrefactor
Refactorrevert
Undo edittest
Test relateddocs
Documentation/noteschore
Dependency update/scaffolding configuration modification etc.workflow
Workflow improvementsci
Continuous integrationtypes
Type definition file changeswip
In development
Related warehouse
If these plugins are helpful to you, you can show support by leaving a star!
- vite-plugin-mock - Used for local and development environment data mock
- vite-plugin-html - Used for html template conversion and compression
- vite-plugin-compression - Used to pack input .gz|.brotil files
- vite-plugin-svg-icons - Used to quickly generate svg sprite
Browser support
The Chrome 80+
browser is recommended for local development
Support modern browsers, doesn't include IE
IE |
Edge |
Firefox |
Chrome |
Safari |
---|---|---|---|---|
not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |