admin-fe/README.md

160 lines
5 KiB
Markdown
Raw Normal View History

2017-11-21 08:10:22 +00:00
<p align="center">
2017-11-21 08:15:34 +00:00
<img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
2017-11-21 08:10:22 +00:00
</p>
<p align="center">
<a href="https://github.com/vuejs/vue">
<img src="https://img.shields.io/badge/vue-2.5.10-brightgreen.svg" alt="vue">
</a>
<a href="https://github.com/ElemeFE/element">
2018-04-13 02:28:52 +00:00
<img src="https://img.shields.io/badge/element--ui-2.3.0-brightgreen.svg" alt="element-ui">
</a>
<a href="https://travis-ci.org/PanJiaChen/vue-element-admin" rel="nofollow">
<img src="https://travis-ci.org/PanJiaChen/vue-element-admin.svg?branch=master" alt="Build Status">
</a>
<a href="https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
</a>
<a href="https://github.com/PanJiaChen/vue-element-admin/releases">
<img src="https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg" alt="GitHub release">
</a>
</p>
2017-07-31 06:45:32 +00:00
English | [简体中文](./README.zh-CN.md)
2017-07-31 06:45:32 +00:00
## Introduction
2017-07-31 06:45:32 +00:00
`vue-element-admin` is a production-ready solution for admin interfaces. Based on [Vue.js](https://github.com/vuejs/vue) and use the UI Toolkit -- [element](https://github.com/ElemeFE/element). `vue-element-admin` is a magical vue admin, it based on the newest development stack of vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. It helps you build a large complex Single-Page Applications. I believe whatever your needs are, this project will help you.
2017-04-25 05:53:49 +00:00
- [Preview](http://panjiachen.github.io/vue-element-admin)
2017-05-12 05:56:22 +00:00
- [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/)
2017-05-16 03:08:17 +00:00
2018-04-16 10:09:53 +00:00
- [Gitter](https://gitter.im/vue-element-admin/discuss)
2018-03-13 10:01:42 +00:00
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
2017-11-29 02:33:39 +00:00
2018-03-13 10:01:42 +00:00
- [Donate](https://panjiachen.github.io/vue-element-admin-site/#/donate)
2017-07-19 08:23:40 +00:00
2018-06-19 09:53:30 +00:00
**vue-element-admin is an admin interfaces integration solution, which is not suitable for secondary development as a base template.**
2017-07-07 03:12:49 +00:00
- Base template recommends using: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
- Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
2017-04-25 06:29:48 +00:00
2018-04-13 02:28:52 +00:00
**Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+**
2017-05-16 03:08:17 +00:00
## Preparation
2017-09-11 02:56:28 +00:00
2018-06-25 02:09:19 +00:00
You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](http://es6.ruanyifeng.com/), [vue](https://cn.vuejs.org/index.html), [vuex](https://vuex.vuejs.org/zh-cn/), [vue-router](https://router.vuejs.org/zh-cn/) and [element-ui](https://github.com/ElemeFE/element). All data requests for this project are simulated using [Mock.js](https://github.com/nuysoft/Mock). It would be helpful if you have pre-existing knowledge on those.
2017-06-14 10:02:12 +00:00
**This project is not a scaffolding and is more of an integrated solution.**
2017-06-14 10:02:12 +00:00
**This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.**
2017-06-14 10:02:12 +00:00
<p align="center">
<img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
</p>
2017-04-25 05:53:49 +00:00
## Features
```
- Login / Logout
- Permission authentication
- Multi-environment build
- Dynamic sidebar (supports multi-level routing)
- Dynamic breadcrumb
- I18n
- Customizable theme
- Tags-view(Tab page Support right-click operation)
- Rich text editor
- Markdown editor
- JSON editor
- Screenfull
- Drag and drop list
- Svg Sprite
2017-11-29 02:33:39 +00:00
- Dashboard
- Guide Page
- Mock data
- Echarts
- Clipboard
- 401/404 error page
- Error log
- Export excel
- Export zip
- Front-end visualization excel
2018-01-23 07:12:17 +00:00
- Tree Table
2017-11-29 02:33:39 +00:00
- Table example
- Dynamictable example
- Drag and drop table example
- Inline edit table example
2017-11-29 02:33:39 +00:00
- Form example
- Two-step login
2017-11-29 02:33:39 +00:00
- SplitPane
2018-04-13 05:35:43 +00:00
- Drag Dialog
2017-11-29 02:33:39 +00:00
- Dropzone
- Sticky
- CountTo
- Markdown to html
```
## Getting started
2017-04-25 05:53:49 +00:00
2017-04-24 09:04:40 +00:00
```bash
2018-02-06 10:46:47 +00:00
# clone the project
git clone https://github.com/PanJiaChen/vue-element-admin.git
2017-04-25 05:53:49 +00:00
# install dependency
npm install
2017-04-25 05:53:49 +00:00
# develop
npm run dev
2017-04-24 09:04:40 +00:00
```
2017-04-25 05:53:49 +00:00
This will automatically open http://localhost:9527.
## Build
2017-04-24 10:19:35 +00:00
```bash
# build for test environment
npm run build:sit
# build for production environment
npm run build:prod
```
## Advanced
```bash
# --report to build with bundle size analytics
npm run build:prod --report
2017-04-25 05:53:49 +00:00
# --preview to start a server in local to preview
npm run build:prod --preview
2017-04-24 10:19:35 +00:00
# lint code
npm run lint
2017-04-25 05:53:49 +00:00
# auto fix
npm run lint -- --fix
2017-04-25 05:53:49 +00:00
```
Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/deploy) for more information
2017-05-31 10:28:06 +00:00
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
## Online Demo
[Preview](http://panjiachen.github.io/vue-element-admin)
2017-11-29 02:33:39 +00:00
## Donate
If you find this project useful, you can buy author a glass of juice :tropical_drink:
![donate](https://wpimg.wallstcn.com/bd273f0d-83a0-4ef2-92e1-9ac8ed3746b9.png)
[Paypal Me](https://www.paypal.me/panfree23)
2017-07-19 08:23:40 +00:00
2018-03-01 02:41:09 +00:00
[Buy me a coffee](https://www.buymeacoffee.com/Pan)
2017-07-19 08:23:40 +00:00
## License
[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
2017-12-29 08:11:20 +00:00
Copyright (c) 2017-present PanJiaChen