From e6ff20b17ee0d17d50d89c493bd8fa90a559d5a4 Mon Sep 17 00:00:00 2001 From: cKey <35512826+colinin@users.noreply.github.com> Date: Tue, 30 Jun 2020 14:51:10 +0800 Subject: [PATCH] improve README --- README.en.md | 113 +++++++++++++++++++++++++++++++++++---------------- README.md | 31 ++++++++------ 2 files changed, 95 insertions(+), 49 deletions(-) diff --git a/README.en.md b/README.en.md index f4edfe568..8cc02ff7e 100644 --- a/README.en.md +++ b/README.en.md @@ -1,44 +1,13 @@ -

- -

- -

- - vue - - - element-ui - - - CircleCI - - - PRs Welcome - - - License: MIT - - - Template from jarvis - -

- English | [简体中文](./README.md) ## Overview -[vue-typescript-admin-template](http://armour.github.io/vue-typescript-admin-template) is a production-ready front-end solution for admin interfaces based on [vue](https://github.com/vuejs/vue), [typescript](https://www.typescriptlang.org/) and UI Toolkit [element-ui](https://github.com/ElemeFE/element). The original Javascript version code [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin/) was written by [PanJiaChen](https://github.com/PanJiaChen), many thanks to him for the awesome open source project! :) - -If you want to get started with a minimal template code instead of integration solution, you can take a look at the [minimal](https://github.com/Armour/vue-typescript-admin-template/tree/minimal) branch. +This is a [vue-typescript-admin-template](http://armour.github.io/vue-typescript-admin-template) -based Abp framework background management interface ## Documentation [Docs](https://armour.github.io/vue-typescript-admin-docs) -## Live demo - -[Demo](https://armour.github.io/vue-typescript-admin-template) - ## Screenshots ![Login](./vueJs/images/userLogin.png) @@ -143,8 +112,7 @@ Javascript version: ## Preparation -You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [typescript](https://www.typescriptlang.org/), [vue](https://vuejs.org/index.html), [vuex](https://vuex.vuejs.org/), [vue-router](https://router.vuejs.org/), [vue-cli](https://github.com/vuejs/vue-cli) , [axios](https://github.com/axios/axios) and [element-ui](https://github.com/ElemeFE/element), all request data is simulated using [faker.js](https://github.com/Marak/Faker.js). -Understanding and learning these knowledge in advance will greatly help you on using this project. +You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [typescript](https://www.typescriptlang.org/), [vue](https://vuejs.org/index.html), [vuex](https://vuex.vuejs.org/), [vue-router](https://router.vuejs.org/), [vue-cli](https://github.com/vuejs/vue-cli) , [axios](https://github.com/axios/axios) and [element-ui](https://github.com/ElemeFE/element), Understanding and learning these knowledge in advance will greatly help you on using this project. ## Project Structure @@ -193,16 +161,89 @@ Understanding and learning these knowledge in advance will greatly help you on u With [yarn](https://yarnpkg.com/lang/en/) or [npm](https://www.npmjs.com/get-npm) + #### Install dependencies ```bash yarn install + ``` -#### Compiles and hot-reloads for development +### Custom vue project config + +[.env.Github.production](./.env.Github.production) 变更为 .env.production +
+[vue.config.github.js ](./vue.config.github.js ) 变更为 vue.config.js + +Modify the server address that the development environment will use for the proxy. Provide the following three addresses: IdentityService, IdentityServer, and ApiService ```bash -yarn run serve + + proxy: { + [process.env.VUE_APP_BASE_IDENTITY_SERVER]: { + target: 'your identityService address', + changeOrigin: true, + pathRewrite: { + ['^' + process.env.VUE_APP_BASE_IDENTITY_SERVER]: '' + } + }, + [process.env.VUE_APP_BASE_IDENTITY_SERVICE]: { + target: 'your identityServer address', + changeOrigin: true, + pathRewrite: { + ['^' + process.env.VUE_APP_BASE_IDENTITY_SERVICE]: '' + } + }, + [process.env.VUE_APP_BASE_API]: { + target: 'you api gateway address', + changeOrigin: true, + pathRewrite: { + ['^' + process.env.VUE_APP_BASE_API]: '' + } + } + } + +``` + +Modify the actual address of the production environment, as above + +```bash + +# Base api +# Remeber to change this to your production server address +# Here I used my mock server for this project +# VUE_APP_BASE_API = 'https://vue-typescript-admin-mock-server.armour.now.sh/mock-api/v1/' + +VUE_APP_BASE_API = 'your api gateway address' + +VUE_APP_BASE_IDENTITY_SERVICE = 'your identityService address' + +VUE_APP_BASE_IDENTITY_SERVER = 'your identityServer address' + +# client id +VUE_APP_CLIENT_ID = 'vue-admin-element' +# client secret +VUE_APP_CLIENT_SECRET = '1q2w3e*' + +``` + +### Compiles background services + +```shell +cd aspnet-core/services + +start-all-service.bat + +``` + +#### Compiles and hot-reloads for development + +```shell + +cd vueJs + +start-vue-admin.bat + ``` #### Compiles and minifies for production diff --git a/README.md b/README.md index 7c4f53eac..c1a1bb115 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,12 @@ ## 总览 -[vue-typescript-admin-template](http://armour.github.io/vue-typescript-admin-template) 是一个后台前端解决方案，它基于 [vue](https://github.com/vuejs/vue), [typescript](https://www.typescriptlang.org/) 和 [element-ui](https://github.com/ElemeFE/element)实现。原始的 Javascript 版本的代码是由 [PanJiaChen](https://github.com/PanJiaChen) 开发维护的 [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin/)， 十分感谢大佬对开源社区做出的贡献 :) +这是一个基于 [vue-typescript-admin-template](http://armour.github.io/vue-typescript-admin-template) 的Abp框架后台管理界面 -如果你想从一个十分简单的基础模版开始，而不是直接使用这个功能丰富的集成方案的话，你可以看一看本项目的 [minimal](https://github.com/Armour/vue-typescript-admin-template/tree/minimal) 分支. - -通过这个前端框架，作者尝试集成后台abp框架，提供管理页面的支持 - -## 线上文档 +## 前端文档 [文档](https://armour.github.io/vue-typescript-admin-docs/zh) -## 线上地址 - -[示例](https://armour.github.io/vue-typescript-admin-template) - ## 截图 ![登录页](./vueJs/images/userLogin.png) @@ -129,7 +121,7 @@ Javascript 版本: ## 前序准备 -你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [typescript](https://www.typescriptlang.org/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) 、[vue-cli](https://github.com/vuejs/vue-cli) 、[axios](https://github.com/axios/axios) 和 [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[faker.js](https://github.com/Marak/Faker.js)进行模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。 +你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [typescript](https://www.typescriptlang.org/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) 、[vue-cli](https://github.com/vuejs/vue-cli) 、[axios](https://github.com/axios/axios) 和 [element-ui](https://github.com/ElemeFE/element)，提前了解和学习这些知识会对使用本项目有很大的帮助。 ## 目录结构 @@ -242,10 +234,23 @@ VUE_APP_CLIENT_SECRET = '1q2w3e*' ``` +### 启动后台服务 + +```shell +cd aspnet-core/services + +start-all-service.bat + +``` + ### 启动本地开发环境（自带热启动） -```bash -yarn serve +```shell + +cd vueJs + +start-vue-admin.bat + ``` ### 构建生产环境 (自带压缩)