diff --git a/README.md b/README.md index c7ed03b6..4438ef77 100644 --- a/README.md +++ b/README.md @@ -1,158 +1,42 @@ -

- -

+## 简介 -

- - vue - - - element-ui - - - Build Status - - - license - - - GitHub release - -

+本项目是基于 `api工厂` 接口 和 `vue-element-admin` 开发的后台管理系统。 -English | [简体中文](./README.zh-CN.md) +[api工厂](https://www.it120.cc/) 是一个 PAAS 提供商, +您可以根据工厂提供的各种api接口,开发出您自己的 SAAS 应用,非常方便。 -## Introduction +`vue-element-admin` 是一个后台集成解决方案,它基于 [Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。 -`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. +欢迎大家一起来参与开发,踊跃提交代码,交流QQ群:479413914 -- [Preview](http://panjiachen.github.io/vue-element-admin) +- [后台接口文档](http://user.api.it120.cc/swagger-ui.html) -- [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/) +- [vue-element-admin 演示](http://panjiachen.github.io/vue-element-admin) -- [Gitter](https://gitter.im/vue-element-admin/discuss) - -- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) - -- [Donate](https://panjiachen.github.io/vue-element-admin-site/#/donate) - -**vue-element-admin is a admin interfaces integration solution, which is not suitable for secondary development as a base template.** - - - Base template recommends using: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)   - - Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) - -**Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+** - -## Preparation - -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/) 和 [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. - - **This project is not a scaffolding and is more of an integrated solution.** - - **This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.** - -

- -

- -## 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 -- Dashboard -- Mock data -- Echarts -- Clipboard -- 401/404 error page -- Error log -- Export excel -- Export zip -- Front-end visualization excel -- Tree Table -- Table example -- Dynamictable example -- Drag and drop table example -- Inline edit table example -- Form example -- Two-step login -- SplitPane -- Drag Dialog -- Dropzone -- Sticky -- CountTo -- Markdown to html -``` - -## Getting started +- [vue-element-admin 使用文档](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/) +## 开发 ```bash -# clone the project -git clone https://github.com/PanJiaChen/vue-element-admin.git +# 克隆项目 +git clone https://github.com/gooking/apifactory-user-admin.git -# install dependency +# 安装依赖 npm install +    +# 建议不要用cnpm安装 会有各种诡异的bug 可以通过如下操作解决 npm 下载速度慢的问题 +npm install --registry=https://registry.npm.taobao.org -# develop +# 启动服务 npm run dev ``` +浏览器访问 http://localhost:9527 -This will automatically open http://localhost:9527. - -## Build +## 发布 ```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 - -# --preview to start a server in local to preview -npm run build:prod --preview - -# lint code -npm run lint - -# auto fix -npm run lint -- --fix -``` - -Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/deploy) for more information - -## 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) - -## 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) - -[Buy me a coffee](https://www.buymeacoffee.com/Pan) - -## License - -[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) - -Copyright (c) 2017-present PanJiaChen + \ No newline at end of file diff --git a/README.zh-CN.md b/README.zh-CN.md deleted file mode 100644 index 4fc5ebc5..00000000 --- a/README.zh-CN.md +++ /dev/null @@ -1,168 +0,0 @@ -

- -

- -

- - vue - - - element-ui - - - Build Status - - - license - - - GitHub release - -

- -简体中文 | [English](./README.md) - -## 简介 - -`vue-element-admin` 是一个后台集成解决方案,它基于 [Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈,内置了i18国际化解决方案,动态路由,权限验证等很多功能特性,相信不管你的需求是什么,本项目都能帮助到你。 - -- [在线访问](http://panjiachen.github.io/vue-element-admin) - -- [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/) - -- [Gitter讨论组](https://gitter.im/vue-element-admin/discuss) - -- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) - -- [Donate](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/donate) - -**本项目的定位是后台集成方案,不适合当基础模板来开发。** - - 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)   - - 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) - -**注意:该项目使用 element-ui@2.3.0+ 版本,所以最低兼容 vue@2.5.0+** - -## 前序准备 - -你的本地环境需要安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。我们的技术栈基于 [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),所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)模拟,提前了解和学习这些知识会对使用本项目有很大的帮助。 - -同时配套一个系列的教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目 - - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2) - - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac) - - [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35) - - [手摸手,带你用 vue 撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56) - - [手摸手,带你封装一个 vue component](https://segmentfault.com/a/1190000009090836) - - [手摸手,带你优雅的使用 icon](https://juejin.im/post/59bb864b5188257e7a427c09) - - - 或者加入该群主 **[圈子](https://jianshiapp.com/circles/1209)** 楼主会经常分享一些技术相关的东西 - - **如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr** - - **本项目并不是一个脚手架,更倾向于是一个集成解决方案** - - **该项目不支持低版本浏览器(如ie),有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)** - -

- -

- -## 功能 -``` -- 登录/注销 -- 权限验证 -- 多环境发布 -- 动态侧边栏(支持多级路由) -- 动态面包屑 -- 国际化多语言 -- 多种动态换肤 -- 快捷导航(标签页) -- 富文本编辑器 -- Markdown编辑器 -- JSON编辑器 -- Screenfull全屏 -- 列表拖拽 -- Svg Sprite 图标 -- Dashboard -- 本地mock数据 -- Echarts 图表 -- Clipboard(剪贴复制) -- 401/404错误页面 -- 错误日志 -- 导出excel -- 导出zip -- 前端可视化excel -- 树形table -- Table example -- 动态table example -- 拖拽table example -- 内联编辑table example -- Form example -- 二步登录 -- SplitPane -- 拖拽 Dialog -- Dropzone -- Sticky -- CountTo -- Markdown2html -``` - -## 开发 -```bash -# 克隆项目 -git clone https://github.com/PanJiaChen/vue-element-admin.git - -# 安装依赖 -npm install -    -# 建议不要用cnpm安装 会有各种诡异的bug 可以通过如下操作解决 npm 下载速度慢的问题 -npm install --registry=https://registry.npm.taobao.org - -# 启动服务 -npm run dev -``` -浏览器访问 http://localhost:9527 - -## 发布 -```bash -# 构建测试环境 -npm run build:sit - -# 构建生成环境 -npm run build:prod -``` - -## 其它 -```bash -# --report to build with bundle size analytics -npm run build:prod --report - -# --preview to start a server in local to preview -npm run build:prod --preview - -# lint code -npm run lint - -# auto fix -npm run lint -- --fix -``` - -更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/deploy) - -## Changelog -Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases). - -## Online Demo -[在线 Demo](http://panjiachen.github.io/vue-element-admin) - -## Donate -如果你觉得这个项目帮助到了你,你可以帮作者买一杯果汁表示鼓励 :tropical_drink: -![donate](https://panjiachen.github.io/donate/donation.png) - -[Paypal Me](https://www.paypal.me/panfree23) - -## License - -[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) - -Copyright (c) 2017-present PanJiaChen