diff --git a/web-vue/README.md b/web-vue/README.md index 05273d347..d9254fbee 100644 --- a/web-vue/README.md +++ b/web-vue/README.md @@ -1,24 +1,60 @@ # web-vue -## Project setup +## English + +### Description + +This is a Jpom front-end project, and the main content is to rewirte a set of UI pages. + +This project used Vue and AntDesign Vue. + +Here are some screenshots to visually compare the two versions. + +... + +### Getting Start + +If you are first time to run this project, you need make sure that you have installed Node.js. + +Then, like other Vue projects, just use command line tools and exec those command. ``` yarn install ``` - -### Compiles and hot-reloads for development ``` yarn serve ``` -### Compiles and minifies for production -``` -yarn build -``` +### Project modules +--web-vue +----public => public files +----src +------api => there are api directory +------assets => static files +------pages => UI pages +------router => vue router +------store => vue store +------utils => utils file +------App.vue +------main.js +------vue.config.js => some config +------package.json -### Lints and fixes files -``` -yarn lint -``` +## 中文 -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +### 介绍 + +这是一个 Jpom 的前端项目,主要内容是重写了一套 UI 页面。使用了 Vue 和 AntDesign Vue. + +下面是一些截图,可以直观的对比两个版本: + +### 开始 +如果你是第一次运行这个项目,你需要保证你的电脑里已经装好了 Node 环境。然后像其他 Vue 项目一样,使用下面的命令去执行就可以使用浏览器看到效果了。 +``` +yarn install +``` +``` +yarn serve +``` +``` +yarn install +```