diff --git a/README.md b/README.md index 93cebafa..fda9814a 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ English | [简体中文](./README.zh-CN.md) ## Introduction -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. +`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. - [Preview](http://panjiachen.github.io/vue-element-admin) @@ -43,17 +43,17 @@ vue-element-admin is a production-ready solution for admin interfaces. Based on ## 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 are simulated with [Mock.js](https://github.com/nuysoft/Mock). It would be helpful if you have pre-existing knowledge on those. +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 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** + **This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.**

-## Feature +## Features ``` - Login / Logout - Permission authentication @@ -91,7 +91,7 @@ You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) l - Markdown to html ``` -## Quickstart +## Getting started ```bash # clone the projice @@ -100,13 +100,12 @@ git clone https://github.com/PanJiaChen/vue-element-admin.git # install dependency npm install -# developmen +# develop npm run dev ``` This will automatically open http://localhost:9527. - ## Build ```bash # build for test environment @@ -131,7 +130,7 @@ npm run lint npm run lint -- --fix ``` -Refer to [https://panjiachen.github.io/vue-element-admin-site/#/deploy]() for more information +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). diff --git a/README.zh-CN.md b/README.zh-CN.md index 42f8463c..d46a3c12 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -24,7 +24,7 @@ ## 简介 -vue-element-admin 是一个后台集成解决方案，[Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈，内置了 i18国际化解决方案，动态路由，权限验证等很多功能特性，相信不管你的需求是什么，本项目都能帮助到你。 +`vue-element-admin` 是一个后台集成解决方案，它基于 [Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈，内置了i18国际化解决方案，动态路由，权限验证等很多功能特性，相信不管你的需求是什么，本项目都能帮助到你。 - [在线访问](http://panjiachen.github.io/vue-element-admin) @@ -42,7 +42,7 @@ vue-element-admin 是一个后台集成解决方案，[Vue.js](https://github.co ## 前序准备 -你的本地环境需要安装 [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/) 和 [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。 +你的本地环境需要安装 [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)