Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
一臭打代码的 aka 潘先生です
vue-vben-admin
提交
74378960
V
vue-vben-admin
项目概览
一臭打代码的 aka 潘先生です
/
vue-vben-admin
与 Fork 源项目一致
从无法访问的项目Fork
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
V
vue-vben-admin
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
74378960
编写于
10月 14, 2020
作者:
C
chen-xt
提交者:
GitHub
10月 14, 2020
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
feat: add README.en-US.md (#37)
上级
7c4dd244
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
235 addition
and
1 deletion
+235
-1
README.en-US.md
README.en-US.md
+234
-0
README.md
README.md
+1
-1
未找到文件。
README.en-US.md
0 → 100644
浏览文件 @
74378960
<p
align=
"center"
>
<a
href=
"https://github.com/anncwb/vue-vben-admin"
target=
"_blank"
>
<img
alt=
"VbenAdmin Logo"
width=
"200"
src=
"./.github/res/imgs/logo.png"
>
</a>
</p>
<h2
align=
"center"
>
VUE VBEN ADMIN2.0
</h2>
[
Chinese
](
./README.md
)
|
**English**
[
CHANGELOG
](
CHANGELOG.md
)
-
[
Introduction
](
#Introduction
)
-
[
GitHub
](
#Github
)
-
[
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 ontribution
](
#Code
ontribution)
-
[
Finished features
](
#Finished
features)
-
[
Developing features
](
#Developing
features)
-
[
Join us
](
#Join
us)
## Introduction
This branch is a 2.0 new branch which use vue3 to develop.
You can also switch to 1.0 branch which use
`vue2.6`
,
`vue-composition-api`
and
`vue-cli`
to develop.
The project is based on the vue3 style background management system implemented by
`ant-design-vue`
,
`typescript`
,
`vue3.0`
,
`vite`
,
`tsx`
.
## GitHub
[
vue-vben-admin2.0
](
https://github.com/anncwb/vue-vben-admin
)
-
`main`
branch
## Preview
[
2.0 preview
](
https://vvbin.cn/next/
)
Account for test: vben/123456
<p
align=
"center"
>
<img
alt=
"VbenAdmin Logo"
width=
"100%"
src=
"./.github/res/imgs/preview1.png"
>
<img
alt=
"VbenAdmin Logo"
width=
"100%"
src=
"./.github/res/imgs/preview2.png"
>
<img
alt=
"VbenAdmin Logo"
width=
"100%"
src=
"./.github/res/imgs/preview3.png"
>
</p>
## Documentation
The documentation for 2.0 hasn't started yet, it will be provided later.
## Preinstallation
### Environmental requirements
-
`Node.js`
: - Version>
`12.0.0`
is better.
-
`yarn`
>
`npm`
>
`cnpm`
: - Package management tool.
### UI framework
-
[
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
-
[
moment
](
https://github.com/moment/moment
)
- Time operation 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
```
js
// Make git case sensitive to file names
git
config
core
.
ignorecase
false
// Pull code of the project
git
clone
https
:
//github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0
cd
vue
-
vben
-
admin
-
2.0
// 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
```
## Usage
### Development environment
```
bash
yarn serve
```
### Build
```
bash
yarn build
# build
yarn build:no-cache
# build, cache will be removed before build
yarn report
# Generate build package report preview
```
### Format
```
bash
yarn lint:stylelint
# css formatting
yarn lint:prettier
# js/ts code formatting
```
### Other
```
bash
yarn reinstall
# Remove dependencies and reinstall, supported window
yarn preview
# Build and preview in local
yarn log
# Generate CHANGELOG
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!
2.
Create your own 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`
## Finished features
-
[x] Project construction (based on vite))
-
[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
## Developing features
-
[ ] Upload component
-
[ ] Rich text component
-
[ ] Data import and export
-
[ ] Global error handling
-
[ ] Theme configuration
-
[ ] Dark theme
-
[ ] Build Gzip
-
[ ] Build CDN
-
[ ] System performance optimization
If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue.
README.md
浏览文件 @
74378960
...
...
@@ -5,7 +5,7 @@
</p>
<h2
align=
"center"
>
VUE VBEN ADMIN2.0
</h2>
**中文**
|
[
English
](
./README
-E
S.md
)
**中文**
|
[
English
](
./README
.en-U
S.md
)
[
更新日志
](
CHANGELOG.md
)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录